allpy
diff 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 diff
1.1 --- a/README.devel Fri Apr 15 20:57:33 2011 +0400 1.2 +++ b/README.devel Fri Apr 15 21:05:50 2011 +0400 1.3 @@ -1,13 +1,36 @@ 1.4 +Using library in-place 1.5 +====================== 1.6 + 1.7 To use the library in-place, without installing, you have to add it's 1.8 directory to PYTHONPATH. 1.9 1.10 -e.g, type this in your shell: 1.11 +e.g, type this in your shell:: 1.12 1.13 - export PYTHONPATH=`pwd` 1.14 + export PYTHONPATH=`pwd` 1.15 1.16 -alternatively, you can type: 1.17 +alternatively, you can type:: 1.18 1.19 . ./SETPATH 1.20 1.21 which adds the right path to PYTHONPATH and also adds 'utils' directory 1.22 -to PATH 1.23 +to PATH. 1.24 + 1.25 +NEWS file 1.26 +========= 1.27 + 1.28 +NEWS file contains news that are important to the library users, not to the 1.29 +devels. It must contain a word abot every change in any interfaces. It may 1.30 +contain a word about bugfix, if that bugfix was important and could cause users 1.31 +some grief. It must not contain anything else. 1.32 + 1.33 +Example file format:: 1.34 + 1.35 + 1.3.0 (2011-04-15) 1.36 + 1.37 + * new: new feature description 1.38 + * new: new feature description 1.39 + * change(!): critical library interface change 1.40 + * change: change in the library interface 1.41 + * bugfix: short bug summary, see #ticket 1.42 + * bugfix: important bug that could destroy the Earth but did not hit trac 1.43 +