javaclass

Change of README.txt

186:5403f0ecc06a
README.txt
     1.1 --- a/README.txt	Thu Mar 24 00:54:11 2011 +0100
     1.2 +++ b/README.txt	Thu Mar 24 00:58:05 2011 +0100
     1.3 @@ -4,17 +4,21 @@
     1.4  Installation
     1.5  ------------
     1.6  
     1.7 -Usually, I issue this command first:
     1.8 +To build the software, perhaps as part of a packaging process, you can run the
     1.9 +following command:
    1.10  
    1.11    python setup.py build
    1.12  
    1.13 -The following should, in any case, be sufficient:
    1.14 +To directly install the software in a system-wide location, you can run the
    1.15 +following command:
    1.16  
    1.17    python setup.py install
    1.18  
    1.19 -I don't think distutils supports uninstall, but the installation just adds
    1.20 -the java and javaclass packages to your site-packages directory and the
    1.21 -runclass.py program to the same bin directory that python resides in.
    1.22 +The installation adds the java and javaclass packages to your site-packages
    1.23 +directory and the runclass.py program to the same bin directory that python
    1.24 +resides in. However, it is arguably preferable to make an operating system
    1.25 +package for the software and use the system's package manager to install and
    1.26 +potentially uninstall the software.
    1.27  
    1.28  Testing
    1.29  -------
    1.30 @@ -23,6 +27,25 @@
    1.31  
    1.32    python test.py
    1.33  
    1.34 +Contact, Copyright and Licence Information
    1.35 +------------------------------------------
    1.36 +
    1.37 +The current Web page for javaclass at the time of release is:
    1.38 +
    1.39 +http://www.boddie.org.uk/python/javaclass.html
    1.40 +
    1.41 +Copyright and licence information can be found in the docs directory - see
    1.42 +docs/COPYING.txt, docs/lgpl-3.0.txt and docs/gpl-3.0.txt for more information.
    1.43 +
    1.44 +Dependencies
    1.45 +------------
    1.46 +
    1.47 +Python              Tested with Python 2.3, although javaclass.classfile
    1.48 +                    should work on any recent Python 2.x release.
    1.49 +
    1.50 +A Java toolchain    Tested with whichever Sun JDK for Java release was current
    1.51 +                    in 2005. ;-)
    1.52 +
    1.53  Class Search Paths
    1.54  ------------------
    1.55  
    1.56 @@ -162,13 +185,19 @@
    1.57  Consider nicer ways of writing the method names in Python, perhaps using a
    1.58  function which takes the individual parameter types as arguments.
    1.59  
    1.60 +New in javaclass 0.2 (Changes since javaclass 0.1)
    1.61 +--------------------------------------------------------
    1.62 +
    1.63 +  * Added Braden Thomas' class file serialisation patches.
    1.64 +  * Relicensed under the LGPL version 3 or later.
    1.65 +
    1.66  Release Procedures
    1.67  ------------------
    1.68  
    1.69  Update the javaclass/__init__.py __version__ attribute.
    1.70  Update the release notes (see above).
    1.71 +Update the setup.py and PKG-INFO files.
    1.72  Check the setup.py file and ensure that all package directories are
    1.73  mentioned.
    1.74  Tag, export.
    1.75 -Rename ClassFile to javaclass (and add the release to the directory name).
    1.76  Archive, upload.