![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/README.txt b/README.txt
index 4dc1b066c6e689d900c48f171c3cd5e34688e7a1..b6cf8c6391e33772943d7c7405cefaef2f8b78ac 100644 (file)
--- a/README.txt
+++ b/README.txt
- Roundup
- =======
-
-
-1. License
-==========
+=======================================================
+Roundup: an Issue-Tracking System for Knowledge Workers
+=======================================================
+Copyright (c) 2003-2009 Richard Jones (richard@mechanicalcat.net)
+Copyright (c) 2002 eKit.com Inc (http://www.ekit.com/)
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.
-
-2. Installation
-===============
-For installation notes, please see the file INSTALL.TXT
+INSTANT GRATIFICATION
+=====================
-3. Usage
-========
-See the index.html file in the "doc" directory.
+The impatient may try Roundup immediately by typing at the console::
+ python demo.py
-3. Design
-=========
-See the information in the "doc" directory.
-
+To start anew (a fresh demo instance)::
+ python demo.py nuke
-4. TODO
-=======
-Most of the TODO items are captured in comments in the code. In summary:
-
-in general:
- . more unit tests
- . more back-ends
-hyperdb:
- . more efficient reverse lookups
-roundupdb:
- . split the file storage into multiple dirs?
-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
+Run demo.py from the *source* directory; don't try to run demo.py from
+the *installed* directory, it will *break*.
-5. Known Bugs
-=============
+Installation
+============
+For installation instructions, please see installation.txt in the "doc"
+directory.
-date:
- . date subtraction doesn't work correctly "if the dates cross leap years,
- phases of the moon, ..."
-
-6. Author
+Upgrading
=========
-richard@users.sourceforge.net
+For upgrading instructions, please see upgrading.txt in the "doc" directory.
-7. Thanks
-=========
-Well, Ping, of course ;)
+Usage and Other Information
+===========================
+See the index.txt file in the "doc" directory.
+The *.txt files in the "doc" directory are written in reStructedText. If
+you have rst2html installed (part of the docutils suite) you can convert
+these to HTML by running "make html" in the "doc" directory.
-Anthony Baxter, for some good first-release feedback. And then continuing
-support through development on sourceforge.
+License
+=======
+See COPYING.txt