allpy
annotate README.devel @ 1143:a9d4a06ed103
pair-cores/web: add header "Description" before example and description
* * *
1
| author | Boris Nagaev <bnagaev@gmail.com> |
|---|---|
| date | Mon, 14 Jan 2013 02:44:43 +0400 |
| parents | b87eb91bd929 |
| children |
| rev | line source |
|---|---|
| dendik@604 | 1 Using library in-place |
| dendik@604 | 2 ====================== |
| dendik@604 | 3 |
| me@338 | 4 To use the library in-place, without installing, you have to add it's |
| me@338 | 5 directory to PYTHONPATH. |
| me@338 | 6 |
| dendik@604 | 7 e.g, type this in your shell:: |
| me@338 | 8 |
| dendik@604 | 9 export PYTHONPATH=`pwd` |
| me@344 | 10 |
| dendik@604 | 11 alternatively, you can type:: |
| me@344 | 12 |
| me@344 | 13 . ./SETPATH |
| me@344 | 14 |
| me@344 | 15 which adds the right path to PYTHONPATH and also adds 'utils' directory |
| dendik@604 | 16 to PATH. |
| dendik@604 | 17 |
| dendik@604 | 18 NEWS file |
| dendik@604 | 19 ========= |
| dendik@604 | 20 |
| dendik@604 | 21 NEWS file contains news that are important to the library users, not to the |
| dendik@604 | 22 devels. It must contain a word abot every change in any interfaces. It may |
| dendik@604 | 23 contain a word about bugfix, if that bugfix was important and could cause users |
| dendik@604 | 24 some grief. It must not contain anything else. |
| dendik@604 | 25 |
| dendik@605 | 26 The file grows upwards (like blog, so that all the most important things are at |
| dendik@605 | 27 the top, like) |
| dendik@605 | 28 |
| dendik@604 | 29 Example file format:: |
| dendik@604 | 30 |
| dendik@605 | 31 1.3.1 (2011-05-01) |
| dendik@605 | 32 * bugfix: the Moon was going to fall |
| dendik@605 | 33 |
| dendik@604 | 34 1.3.0 (2011-04-15) |
| dendik@604 | 35 |
| dendik@604 | 36 * new: new feature description |
| dendik@604 | 37 * new: new feature description |
| dendik@604 | 38 * change(!): critical library interface change |
| dendik@604 | 39 * change: change in the library interface |
| dendik@604 | 40 * bugfix: short bug summary, see #ticket |
| dendik@604 | 41 * bugfix: important bug that could destroy the Earth but did not hit trac |
| dendik@604 | 42 |