Bug 274
[auf_roundup.git] / README.txt
1 =======================================================
2 Roundup: an Issue-Tracking System for Knowledge Workers
3 =======================================================
4
5 Copyright (c) 2003-2009 Richard Jones (richard@mechanicalcat.net)
6 Copyright (c) 2002 eKit.com Inc (http://www.ekit.com/)
7 Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
8
9
10 INSTANT GRATIFICATION
11 =====================
12
13 The impatient may try Roundup immediately by typing at the console::
14
15    python demo.py
16
17 To start anew (a fresh demo instance)::
18
19    python demo.py nuke
20
21 Run demo.py from the *source* directory; don't try to run demo.py from
22 the *installed* directory, it will *break*.
23
24
25 Installation
26 ============
27 For installation instructions, please see installation.txt in the "doc"
28 directory.
29
30
31 Upgrading
32 =========
33 For upgrading instructions, please see upgrading.txt in the "doc" directory.
34
35
36 Usage and Other Information
37 ===========================
38 See the index.txt file in the "doc" directory.
39 The *.txt files in the "doc" directory are written in reStructedText. If
40 you have rst2html installed (part of the docutils suite) you can convert
41 these to HTML by running "make html" in the "doc" directory.
42
43
44 License
45 =======
46 See COPYING.txt