Skip to content

Commit 2cfaf15

Browse files
committed
doc: enhance README.txt
Add Introduction section, enhance installation directions with basic requirements and virtual env install. Change "For Developers" to "Contributing Guidelines". Added Support/Contact blurb. Added tl;dr version of License.
1 parent f8261e0 commit 2cfaf15

File tree

1 file changed

+61
-9
lines changed

1 file changed

+61
-9
lines changed

README.txt

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

5+
Introduction
6+
============
7+
8+
Roundup is a tool for creating issue trackers. This includes:
9+
10+
* bug trackers,
11+
* help desk,
12+
* agile development trackers,
13+
* customer issue tracking,
14+
* fleet maintenance tracking,
15+
* GTD tool etc.
16+
17+
It comes with predefined trackers meant to be customized for your
18+
workflow. Starting trackers include:
19+
20+
* generic tracker,
21+
* development bug/feature tracker (3 variations),
22+
* bare bones minimal tracker.
23+
24+
Your users interact with (create, read, update, close) issues using a
25+
web interface or by email. It can be programmaticly managed via REST
26+
or XMLRPC, CLI, or via local Python scripts.
27+
28+
The user's guide is at https://www.roundup-tracker.org/docs/user_guide.html.
29+
30+
531
INSTANT GRATIFICATION
632
=====================
733

@@ -11,13 +37,14 @@ the source directory::
1137
python demo.py
1238

1339
This will create new tracker home in "demo" subdirectory and start
14-
server. To reset demo instance::
40+
a web server. To reset demo instance::
1541

1642
python demo.py nuke
1743

1844

1945
Tracker Home
20-
=============
46+
------------
47+
2148
"Tracker Home" is main concept when starting with Roundup. It is
2249
directory where all your tracker data is stored. This directory is
2350
created every time when new tracker is initialized and includes
@@ -26,20 +53,35 @@ tracker configuration, database, template, schema and extensions.
2653

2754
Installation
2855
============
29-
Please see "doc/installation.txt"
56+
57+
Please see "doc/installation.txt". For a basic tracker, only the
58+
Python standard library is required. It can be enhanced by adding
59+
other packages. A basic virtual environment install can be done using:
3060

3161

62+
python3 -m venv roundup
63+
. roundup/bin/activate
64+
python -m pip install roundup
65+
roundup-demo # to start a test demo instance
66+
67+
See "doc/installation.txt" for details on deploying a production
68+
instance.
69+
3270
Upgrading
3371
=========
34-
Please see "doc/upgrading.txt"
72+
73+
Please see "doc/upgrading.txt".
3574

3675

3776
Security Issues
3877
===============
78+
3979
Please see "doc/security.txt" for directions on reporting security issues.
4080

81+
4182
Usage and Other Information
4283
===========================
84+
4385
Start with the index.txt file in the "doc" directory. These
4486
documentation files are written in reStructedText, which can be
4587
converted into HTML format. If you have Sphinx installed, you can
@@ -50,12 +92,22 @@ do this by running::
5092
Resulting HTML files will be in "share/doc/roundup/html" directory.
5193

5294

53-
For Developers
54-
==============
55-
To get started on development work, read the developers.txt file in
56-
the "doc" directory.
95+
Contributing Guidelines
96+
=======================
97+
98+
To get started on development or documentation work, read the file
99+
"doc/developers.txt". This documents the project rules, how to set up
100+
a development environment and submit patches and tests.
101+
102+
Support/Contact
103+
===============
104+
105+
Please see https://www.roundup-tracker.org/contact.html for directions
106+
on using email or IRC to contact the developers.
57107

58108

59109
License
60110
=======
61-
See COPYING.txt
111+
See COPYING.txt.
112+
113+
tl;dr MIT, Zope version 2, Python Software Foundation version 2

0 commit comments

Comments
 (0)