CGI interfaces now spit up a top-level index of all the instances they can

[roundup.git] / README.txt

diff --git a/README.txt b/README.txt
index cd824188f2809b6af4b0c7ff18a7838e7416a6aa..0c89029692379ad6d091ff95a7aad21f2f2deb51 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -4,8 +4,23 @@
 
 1. License
 ==========
-This software is released under the GNU GPL. The copyright is held by Bizar
-Software Pty Ltd (http://www.bizarsoftware.com.au).
+
+Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+This module is free software, and you may redistribute it and/or modify
+under the same terms as Python, so long as this copyright message and
+disclaimer are retained in their original form.
+
+IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OF THIS CODE, EVEN IF BIZAR SOFTWARE PTY LTD HAS BEEN ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+
+BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+
 
 The stylesheet included with this package has been copied from the Zope
 management interface and presumably belongs to Digital Creations.
@@ -19,7 +34,8 @@ For installation notes, please see the file INSTALL.TXT
 3. Usage
 ========
 The system is designed to accessed through the command-line, e-mail or web
-interface.
+interface. Roundup has some useful doucmentation in its docstrings, so
+"pydoc roundup" will give useful information.
 
 3.1 Command-line
 ----------------
@@ -35,6 +51,7 @@ database manipulations such as:
 3.2 E-mail
 ----------
 See the docstring at the start of the roundup/mailgw.py source file.
+Use "pydoc roundup.mailgw".
 
 
 3.3 Web
@@ -69,7 +86,6 @@ in general:
   . more unit tests
   . more back-ends
   . better error handling (nicer messages for users)
-  . possibly revert the entire damn thing to 1.5.2 ... :(
 hyperdb:
   . transaction support
   . more efficient reverse lookups
@@ -77,15 +93,10 @@ roundupdb:
   . split the file storage into multiple dirs?
 roundup-mailgw:
   . errors as attachments
-  . snip signatures?
 roundup-server:
   . check the source file timestamps before reloading
 cgi_client
   . keep form fields in form on bad submission - only clear it if all ok
-  . e-mail messages should have the roundup CGI URL in them
-roundup.cgi
-  . make it detect that it is in an instance_home and just use that
-    instance by default?
 
 
 5. Known Bugs
@@ -94,11 +105,13 @@ roundup.cgi
 date:
   . date subtraction doesn't work correctly "if the dates cross leap years,
     phases of the moon, ..."
+cgi:
+  . enabling a filter disables the current filter hidden fields.
 
 
 6. Author
 =========
-richard@sourceforge.net
+richard@users.sourceforge.net
 
 
 7. Thanks