1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sun Jan 22 00:04:16 2012 +0100
1.3 @@ -0,0 +1,74 @@
1.4 +Introduction
1.5 +------------
1.6 +
1.7 +The MoinSupport distribution provides support libraries for use by MoinMoin
1.8 +extensions. Some of the provided modules can be used independently of
1.9 +MoinMoin, such as the DateSupport and LocationSupport modules which do not
1.10 +themselves import any MoinMoin functionality.
1.11 +
1.12 +Installation
1.13 +------------
1.14 +
1.15 +To install the support library, consider using the moinsetup tool. See the
1.16 +"Recommended Software" section below for more information.
1.17 +
1.18 +With moinsetup and a suitable configuration file, the installation is done as
1.19 +follows with $MSDIR referring to the MoinSupport distribution directory
1.20 +containing this README.txt file:
1.21 +
1.22 + python moinsetup.py -f moinsetup.cfg -m install_extension_package $MSDIR
1.23 +
1.24 +The command above uses the setup.py script provided as follows:
1.25 +
1.26 + python setup.py install --prefix=path-to-moin-prefix
1.27 +
1.28 +Recommended Software
1.29 +--------------------
1.30 +
1.31 +See the "Dependencies" section below for essential software.
1.32 +
1.33 +The moinsetup tool is recommended for installation since it aims to support
1.34 +all versions of MoinMoin that are supported for use with this software.
1.35 +
1.36 +See the following page for information on moinsetup:
1.37 +
1.38 +http://moinmo.in/ScriptMarket/moinsetup
1.39 +
1.40 +Contact, Copyright and Licence Information
1.41 +------------------------------------------
1.42 +
1.43 +See the following Web pages for more information about this work:
1.44 +
1.45 +http://hgweb.boddie.org.uk/MoinSupport
1.46 +
1.47 +The author can be contacted at the following e-mail address:
1.48 +
1.49 +paul@boddie.org.uk
1.50 +
1.51 +Copyright and licence information can be found in the docs directory - see
1.52 +docs/COPYING.txt and docs/LICENCE.txt for more information.
1.53 +
1.54 +Dependencies
1.55 +------------
1.56 +
1.57 +MoinSupport has the following basic dependencies:
1.58 +
1.59 +Packages Release Information
1.60 +-------- -------------------
1.61 +
1.62 +pytz Tested with 2007k (specifically 2007k-0ubuntu2)
1.63 + Source: http://pytz.sourceforge.net/
1.64 +
1.65 +If time zone handling is not required, pytz need not be installed. It is,
1.66 +however, highly recommended that pytz be installed.
1.67 +
1.68 +Release Procedures
1.69 +------------------
1.70 +
1.71 +Update the __version__ attributes in the modules and the setup.py version
1.72 +details.
1.73 +Change the version number and package filename/directory in the documentation.
1.74 +Update the setup.py and PKG-INFO files.
1.75 +Update the release notes (see above).
1.76 +Tag, export.
1.77 +Archive, upload.