# HG changeset patch
# User paulb
# Date 1122066031 0
# Node ID 8273532058560e70980ffb2125adfb476f04bcd0
# Parent  4c793cf266d8f2c7ecab33435c194de8906f751c
[project @ 2005-07-22 21:00:31 by paulb]
Added administrative notes.

diff -r 4c793cf266d8 -r 827353205856 README.txt
--- a/README.txt	Fri Jul 22 20:39:10 2005 +0000
+++ b/README.txt	Fri Jul 22 21:00:31 2005 +0000
@@ -113,3 +113,31 @@
 that there is no apparent need to explicitly declare the corresponding global
 variables in stylesheets. Whilst this is nice, we may eventually need to
 detect such variables and add them in the preparation process.
+
+Release Procedures
+------------------
+
+Update the XSLOutput.py and XSLForms/__init__.py __version__ attributes.
+Change the version number and package filename/directory in the documentation.
+Change code examples in the documentation if appropriate.
+Update the release notes (see above).
+Check the setup.py file and ensure that all package directories are mentioned.
+Tag, export.
+Generate the API documentation.
+Remove generated .pyc files: rm `find . -name "*.pyc"`
+Archive, upload.
+Upload the introductory documentation.
+Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
+
+Generating the API Documentation
+--------------------------------
+
+In order to prepare the API documentation, it is necessary to generate some
+Web pages from the Python source code. For this, the epydoc application must
+be available on your system. Then, inside the XSLTools directory, run the
+apidocs.sh tool script as follows:
+
+./tools/apidocs.sh
+
+Some warnings may be generated by the script, but the result should be a new
+apidocs directory within the XSLTools directory.