allpy
annotate README.devel @ 604:b87eb91bd929
Added a few words about NEWS file to README.devel
| author | Daniil Alexeyevsky <dendik@kodomo.fbb.msu.ru> |
|---|---|
| date | Fri, 15 Apr 2011 21:05:50 +0400 |
| parents | 0586317b3a99 |
| children | 17b6bb5c64d2 |
| 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@604 | 26 Example file format:: |
| dendik@604 | 27 |
| dendik@604 | 28 1.3.0 (2011-04-15) |
| dendik@604 | 29 |
| dendik@604 | 30 * new: new feature description |
| dendik@604 | 31 * new: new feature description |
| dendik@604 | 32 * change(!): critical library interface change |
| dendik@604 | 33 * change: change in the library interface |
| dendik@604 | 34 * bugfix: short bug summary, see #ticket |
| dendik@604 | 35 * bugfix: important bug that could destroy the Earth but did not hit trac |
| dendik@604 | 36 |