|
2 | 2 | Roundup: an Issue-Tracking System for Knowledge Workers |
3 | 3 | ======================================================= |
4 | 4 |
|
5 | | -Copyright (c) 2003-2009 Richard Jones ( [email protected]) |
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 | 5 | INSTANT GRATIFICATION |
11 | 6 | ===================== |
12 | 7 |
|
13 | | -The impatient may try Roundup immediately by typing at the console:: |
| 8 | +The impatient may try Roundup immediately by running demo.py from |
| 9 | +the source directory:: |
14 | 10 |
|
15 | 11 | python demo.py |
16 | 12 |
|
17 | | -To start anew (a fresh demo instance):: |
| 13 | +This will create new tracker home in "demo" subdirectory and start |
| 14 | +server. To reset demo instance:: |
18 | 15 |
|
19 | 16 | python demo.py nuke |
20 | 17 |
|
21 | | -Run demo.py from the *source* directory; don't try to run demo.py from |
22 | | -the *installed* directory, it will *break*. |
| 18 | + |
| 19 | +Tracker Home |
| 20 | +============= |
| 21 | +"Tracker Home" is main concept when starting with Roundup. It is |
| 22 | +directory where all your tracker data is stored. This directory is |
| 23 | +created every time when new tracker is initialized and includes |
| 24 | +tracker configuration, database, template, schema and extensions. |
23 | 25 |
|
24 | 26 |
|
25 | 27 | Installation |
26 | 28 | ============ |
27 | | -For installation instructions, please see installation.txt in the "doc" |
28 | | -directory. |
| 29 | +Please see "doc/installation.txt" |
29 | 30 |
|
30 | 31 |
|
31 | 32 | Upgrading |
32 | 33 | ========= |
33 | | -For upgrading instructions, please see upgrading.txt in the "doc" directory. |
| 34 | +Please see "doc/upgrading.txt" |
34 | 35 |
|
35 | 36 |
|
36 | 37 | Usage and Other Information |
37 | 38 | =========================== |
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 Sphinx installed, you can convert these to HTML by running |
41 | | - $ python setup.py build_doc |
42 | | -from the top of the release directory. |
| 39 | +Start with the index.txt file in the "doc" directory. These |
| 40 | +documentation files are written in reStructedText, which can be |
| 41 | +converted into HTML format. If you have Sphinx installed, you can |
| 42 | +do this by running:: |
| 43 | + |
| 44 | + python setup.py build_doc |
| 45 | + |
| 46 | +Resulting HTML files will be in "share/doc/roundup/html" directory. |
43 | 47 |
|
44 | 48 |
|
45 | 49 | For Developers |
|
0 commit comments