2
2
Roundup: an Issue-Tracking System for Knowledge Workers
3
3
=======================================================
4
4
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
+
5
31
INSTANT GRATIFICATION
6
32
=====================
7
33
@@ -11,13 +37,14 @@ the source directory::
11
37
python demo.py
12
38
13
39
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::
15
41
16
42
python demo.py nuke
17
43
18
44
19
45
Tracker Home
20
- =============
46
+ ------------
47
+
21
48
"Tracker Home" is main concept when starting with Roundup. It is
22
49
directory where all your tracker data is stored. This directory is
23
50
created every time when new tracker is initialized and includes
@@ -26,20 +53,35 @@ tracker configuration, database, template, schema and extensions.
26
53
27
54
Installation
28
55
============
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:
30
60
31
61
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
+
32
70
Upgrading
33
71
=========
34
- Please see "doc/upgrading.txt"
72
+
73
+ Please see "doc/upgrading.txt".
35
74
36
75
37
76
Security Issues
38
77
===============
78
+
39
79
Please see "doc/security.txt" for directions on reporting security issues.
40
80
81
+
41
82
Usage and Other Information
42
83
===========================
84
+
43
85
Start with the index.txt file in the "doc" directory. These
44
86
documentation files are written in reStructedText, which can be
45
87
converted into HTML format. If you have Sphinx installed, you can
@@ -50,12 +92,22 @@ do this by running::
50
92
Resulting HTML files will be in "share/doc/roundup/html" directory.
51
93
52
94
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.
57
107
58
108
59
109
License
60
110
=======
61
- See COPYING.txt
111
+ See COPYING.txt.
112
+
113
+ tl;dr MIT, Zope version 2, Python Software Foundation version 2
0 commit comments