![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/README.txt b/README.txt
index 242172c1fd915327b3b876b3def67172ae025882..b6cf8c6391e33772943d7c7405cefaef2f8b78ac 100644 (file)
--- a/README.txt
+++ b/README.txt
- Roundup
- =======
+=======================================================
+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/)
-1. License
-==========
-This software is released under the same terms as the Python License.
-Copyright 2001, Bizar Software Pty Ltd (http://www.bizarsoftware.com.au).
-The stylesheet included with this package has been copied from the Zope
-management interface and presumably belongs to Digital Creations.
+INSTANT GRATIFICATION
+=====================
+The impatient may try Roundup immediately by typing at the console::
-2. Installation
-===============
-For installation notes, please see the file INSTALL.TXT
+ python demo.py
+To start anew (a fresh demo instance)::
-3. Usage
-========
-The system is designed to accessed through the command-line, e-mail or web
-interface. Roundup has some useful doucmentation in its docstrings, so
-"pydoc roundup" will give useful information.
+ python demo.py nuke
-3.1 Command-line
-----------------
-The command-line tool is called "roundup-admin" and is used for most low-level
-database manipulations such as:
- . creating a database instance
- . redefining the list of products ("create" and "retire" commands)
- . adding users manually, or setting their passwords ("create" and "set")
- . other stuff - run it with no arguments to get a better description of
- what it does.
+Run demo.py from the *source* directory; don't try to run demo.py from
+the *installed* directory, it will *break*.
-3.2 E-mail
-----------
-See the docstring at the start of the roundup/mailgw.py source file.
-Use "pydoc roundup.mailgw".
+Installation
+============
+For installation instructions, please see installation.txt in the "doc"
+directory.
-3.3 Web
--------
-Hopefully, this interface is pretty self-explanatory...
-
-Index views may be modified by the following arguments:
- :sort - sort by prop name, optionally preceeded with '-'
- to give descending or nothing for ascending sorting.
- :group - group by prop name, optionally preceeded with '-' or
- to sort in descending or nothing for ascending order.
- :filter - selects which props should be displayed in the filter
- section. Default is all.
- :columns - selects the columns that should be displayed.
- Default is all.
- propname - selects the values the node properties given by propname
- must have (very basic search/filter).
-
-
-
-3. Design
+Upgrading
=========
-See the information in the "doc" directory.
+For upgrading instructions, please see upgrading.txt in the "doc" directory.
+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.
-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)
- . possibly revert the entire damn thing to 1.5.2 ... :(
-hyperdb:
- . transaction support
- . more efficient reverse lookups
-roundupdb:
- . split the file storage into multiple dirs?
-roundup-mailgw:
- . errors as attachments
-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
-
-
-5. Known Bugs
-=============
-
-date:
- . date subtraction doesn't work correctly "if the dates cross leap years,
- phases of the moon, ..."
-
-
-6. Author
-=========
-richard@users.sourceforge.net
-
-
-7. Thanks
-=========
-Well, Ping, of course ;)
-
-Anthony Baxter, for some good first-release feedback. And then continuing
-support through development on sourceforge.
+License
+=======
+See COPYING.txt