PGP support is again working (pyme API has changed significantly) and we

[roundup.git] / README.txt

diff --git a/README.txt b/README.txt
index 3a4e8337b806c632b1862cc1c068c0307ba8c299..b6cf8c6391e33772943d7c7405cefaef2f8b78ac 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,20 +1,46 @@
+=======================================================
+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/)
+
+
+INSTANT GRATIFICATION
+=====================
+
+The impatient may try Roundup immediately by typing at the console::
+
+   python demo.py
+
+To start anew (a fresh demo instance)::
+
+   python demo.py nuke
+
+Run demo.py from the *source* directory; don't try to run demo.py from
+the *installed* directory, it will *break*.
+
 
 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
-