Fix matching of incoming email addresses to the alternate_addresses

[roundup.git] / README.txt

diff --git a/README.txt b/README.txt
index d9a9642a1fa2b8548b11efad9d55898fa8514941..b6cf8c6391e33772943d7c7405cefaef2f8b78ac 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,35 +1,46 @@
+=======================================================
+Roundup: an Issue-Tracking System for Knowledge Workers
+=======================================================
 
-Installation
-============
-For installation instructions, please see installation.txt /
-installation.html in the "doc" directory.
+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/)
 
 
-Usage and Other Information
-===========================
-See the index.txt / index.html file in the "doc" directory.
+INSTANT GRATIFICATION
+=====================
 
+The impatient may try Roundup immediately by typing at the console::
 
-License
-=======
+   python demo.py
 
-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.
+To start anew (a fresh demo instance)::
 
-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.
+   python demo.py nuke
 
-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.
+Run demo.py from the *source* directory; don't try to run demo.py from
+the *installed* directory, it will *break*.
 
 
-The stylesheet included with this package has been copied from the Zope
-management interface and presumably belongs to Digital Creations.
+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.
+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.
+
+
+License
+=======
+See COPYING.txt