allpy
view 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 |
line source
1 Using library in-place
2 ======================
4 To use the library in-place, without installing, you have to add it's
5 directory to PYTHONPATH.
7 e.g, type this in your shell::
9 export PYTHONPATH=`pwd`
11 alternatively, you can type::
13 . ./SETPATH
15 which adds the right path to PYTHONPATH and also adds 'utils' directory
16 to PATH.
18 NEWS file
19 =========
21 NEWS file contains news that are important to the library users, not to the
22 devels. It must contain a word abot every change in any interfaces. It may
23 contain a word about bugfix, if that bugfix was important and could cause users
24 some grief. It must not contain anything else.
26 Example file format::
28 1.3.0 (2011-04-15)
30 * new: new feature description
31 * new: new feature description
32 * change(!): critical library interface change
33 * change: change in the library interface
34 * bugfix: short bug summary, see #ticket
35 * bugfix: important bug that could destroy the Earth but did not hit trac