Changeset 264:18fa45de345d
- Timestamp:
- 02/13/10 18:53:48 (6 months ago)
- Author:
- rgrp <http://rufuspollock.org>
- Branch:
- default
- Message:
-
[docs][s]: update basic docstring/README with information about shakespeare-admin and paster and fix dates in COPYING.txt.
- Files:
-
Legend:
- Unmodified
- Added
- Removed
-
|
r158
|
r264
|
|
| 1 | | All code and text is copyright (c) 2005-9, the Open Knowledge Foundation. |
| | 1 | All code and text is copyright (c) 2005-2010, the Open Knowledge Foundation. |
| 2 | 2 | |
| 3 | 3 | Licensing of code |
| … |
… |
|
| 5 | 5 | |
| 6 | 6 | All code is license under the MIT License: |
| 7 | | |
| 8 | | Copyright (c) 2005-08, Open Knowledge Foundation |
| 9 | 7 | |
| 10 | 8 | Permission is hereby granted, free of charge, to any person obtaining a copy of |
-
|
r255
|
r264
|
|
| 7 | 7 | a python API and a web interface that provides access to many (but not all) of |
| 8 | 8 | these facilities from the comfort of your web browser (see |
| 9 | | http://www.openshakespeare.org/ for a demo). |
| | 9 | http://www.openshakespeare.org/). |
| 10 | 10 | |
| 11 | 11 | All material is open source/open knowledge so that anyone can use, redistribute |
| … |
… |
|
| 19 | 19 | ******************* |
| 20 | 20 | |
| 21 | | Please mail info@okfn.org or join the okfn-discuss mailing list: |
| | 21 | Please mail open-shakespeare@okfn.org or join the open-literature mailing list: |
| 22 | 22 | |
| 23 | | http://lists.okfn.org/listinfo/okfn-discuss |
| | 23 | http://lists.okfn.org/listinfo/open-literature |
| 24 | 24 | |
| 25 | 25 | |
| … |
… |
|
| 88 | 88 | --------- |
| 89 | 89 | |
| 90 | | 1. Search index. [TODO] |
| | 90 | 1. To load the data packages, make sure you have downloaded and installed the |
| | 91 | relevant data package (e.g. shksprdata or miltondata) and then do:: |
| 91 | 92 | |
| 92 | | 2. To load the author packages, change into the miltondata or shksprdata directories |
| 93 | | and run the command load-milton (or load-shakespeare) -c <path to your |
| 94 | | development.ini> This will load the metadata text into the database. |
| | 93 | shakespeare-admin --config {your-ini-file} db init_shksprdata |
| | 94 | |
| | 95 | 2. Search index. To run the search index you will need xapian and the python |
| | 96 | xapian bindings installed. (On Debian/Ubuntu this is xapian and python-xapian). |
| | 97 | Then take a look at:: |
| | 98 | |
| | 99 | shakespeare-admin search |
| 95 | 100 | |
| 96 | 101 | 3. You can start a web server to provide a easy-to-use web interface to the |
| … |
… |
|
| 101 | 106 | NB: {your-config.ini} should be replaced with the name of the config file you |
| 102 | 107 | created earlier. |
| | 108 | |
| | 109 | 4. In addition to shakespeare-admin commands there are also some paster |
| | 110 | commands. To see what is available:: |
| | 111 | |
| | 112 | paster -h |
| 103 | 113 | |
| 104 | 114 | |
