Code

no idea why this code existed, but bye bye
[roundup.git] / README.txt
index 02f18a99420987cbd357ac3986e091302cee89d4..808be60a4a0ecd75868012bfa756ac55fb0f51de 100644 (file)
@@ -1,9 +1,20 @@
-                                    Roundup
-                                    =======
 
+Installation
+============
+For installation instructions, please see installation.txt in the "doc"
+directory.
+
+Upgrading
+=========
+For upgrading instructions, please see upgrading.txt in the "doc" directory.
+
+Usage and Other Information
+===========================
+See the index.txt file in the "doc" directory.
 
-1. License
-==========
+
+License
+=======
 
 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
@@ -22,67 +33,21 @@ 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.
-
-
-2. Installation
-===============
-For installation notes, please see the file INSTALL.TXT
-
-
-3. Usage
-========
-See the index.html file in the "doc" directory.
-
-
-3. Design
-=========
-See the information in the "doc" directory.
-
-
-
-4. TODO
-=======
-Most of the TODO items are captured in comments in the code. In summary:
-
-in general:
-  . more unit tests
-  . more back-ends
-  . better error handling (nicer messages for users)
-hyperdb:
-  . transaction support
-  . more efficient reverse lookups
-roundupdb:
-  . split the file storage into multiple dirs?
-roundup-mailgw:
-  . errors as attachments
-  . limits on the e-mail addresses that may use the mail gateway
-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
-
+PageTemplates Licensing
+-----------------------
 
-5. Known Bugs
-=============
+Portions of this code (roundup.cgi.PageTemplates, roundup.cgi.TAL and
+roundup.cgi.ZTUtils) have been copied from Zope. They have been modified in
+the following manner:
 
-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@users.sourceforge.net
-
-
-7. Thanks
-=========
-Well, Ping, of course ;)
+- removal of unit tests, Zope-specific code and support files from 
+  PageTemplates: PageTemplateFile.py, ZPythonExpr.py, ZRPythonExpr.py,
+  ZopePageTemplate.py, examples, help, tests, CHANGES.txt, HISTORY.txt,
+  version.txt and www. From TAL: DummyEngine.py, HISTORY.txt, CHANGES.txt,
+  benchmark, driver.py, markbench.py, ndiff.py, runtest.py, setpath.py,
+  tests and timer.py. From ZTUtils: SimpleTree.py, Zope.py, CHANGES.txt and
+  HISTORY.txt.
+- editing to remove dependencies on Zope modules (see files for change notes)
 
-Anthony Baxter, for some good first-release feedback. And then continuing
-support through development on sourceforge.
+The license for this code is in doc/ZPL.txt.