Skip to content

Commit 0f5f512

Browse files
committed
Update README.txt, explain Tracker Home, improve doc
building instructions.
1 parent 21633ca commit 0f5f512

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

README.txt

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,48 @@
22
Roundup: an Issue-Tracking System for Knowledge Workers
33
=======================================================
44

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-
105
INSTANT GRATIFICATION
116
=====================
127

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::
1410

1511
python demo.py
1612

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::
1815

1916
python demo.py nuke
2017

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.
2325

2426

2527
Installation
2628
============
27-
For installation instructions, please see installation.txt in the "doc"
28-
directory.
29+
Please see "doc/installation.txt"
2930

3031

3132
Upgrading
3233
=========
33-
For upgrading instructions, please see upgrading.txt in the "doc" directory.
34+
Please see "doc/upgrading.txt"
3435

3536

3637
Usage and Other Information
3738
===========================
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.
4347

4448

4549
For Developers

0 commit comments

Comments
 (0)