Changeset 4944

Timestamp:

31 Jan 2010, 09:17:50 (15 years ago)

Author:

uli

Message:

Update docs.

File:

• main/waeup.sirp/trunk/README.txt (modified) (3 diffs)

main/waeup.sirp/trunk/README.txt

@@ -1 @@
-waeup
-*****
+waeup.sirp
+**********
 
-A web-based management tool for managing universities and schools.
+The WAeUP Student Information and Registration Portal. `waeup.sirp` is
+a web-based management tool for managing universities and schools.
 
-What is ``waeup``?
-==================
+What is ``waeup.sirp``?
+=======================
 
 The package was created as an effort of the WAeUP group. See
@@ -14 +15 @@
 ============
 
+.. note:: ``waeup.sirp`` does not work with Python > 2.5
+          currently. Use of Python 2.5 is recommended.
+
+.. note:: ``waeup.sirp`` does not work on Windows.
+
 Prerequisites
 -------------
 
-The ``waeup`` package is based on `Grok`_, which is a Python framework
-for agile webapplication development. Grok itself is based on `Zope`_.
+The ``waeup.sirp`` package is based on `Grok`_, which is a Python
+framework for agile webapplication development. Grok itself is based
+on `Zope`_.
 
 .. _Grok: http://grok.zope.org/
@@ -24 +31 @@
 .. _Zope: http://www.zope.org/
 
-To deploy ``waeup`` most easily, we use `zc.buildout`_
+To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_
 
 .. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout