Mercurial > p > roundup > code
annotate README.txt @ 7717:2eb976e1de2a
fix: typo in variable name
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 21 Dec 2023 09:19:08 -0500 |
| parents | 1f6c77ee4b18 |
| children | ac487300590d |
| rev | line source |
|---|---|
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
1 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
2 Roundup: an Issue-Tracking System for Knowledge Workers |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
3 ======================================================= |
|
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
4 |
| 7708 | 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 | |
| 1639 | 31 INSTANT GRATIFICATION |
| 32 ===================== | |
| 33 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
34 The impatient may try Roundup immediately by running demo.py from |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
35 the source directory:: |
| 1639 | 36 |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
37 python demo.py |
| 1639 | 38 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
39 This will create new tracker home in "demo" subdirectory and start |
| 7708 | 40 a web server. To reset demo instance:: |
|
1640
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
41 |
|
d0b29215aa44
pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents:
1639
diff
changeset
|
42 python demo.py nuke |
| 1639 | 43 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
44 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
45 Tracker Home |
| 7708 | 46 ------------ |
| 47 | |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
48 "Tracker Home" is main concept when starting with Roundup. It is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
49 directory where all your tracker data is stored. This directory is |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
50 created every time when new tracker is initialized and includes |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
51 tracker configuration, database, template, schema and extensions. |
|
3646
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
52 |
|
3a9a6b98c6e6
note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents:
1640
diff
changeset
|
53 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
54 Installation |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
55 ============ |
| 7708 | 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: | |
| 60 | |
|
94
9cf5229397fc
name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
61 |
| 7708 | 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. | |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
69 |
|
796
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
70 Upgrading |
|
5324a28060ab
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
791
diff
changeset
|
71 ========= |
| 7708 | 72 |
| 73 Please see "doc/upgrading.txt". | |
|
4092
4b0ddce43d08
migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents:
3949
diff
changeset
|
74 |
|
1576
80519db85eac
More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents:
1409
diff
changeset
|
75 |
|
7127
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
76 Security Issues |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
77 =============== |
| 7708 | 78 |
|
7127
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
79 Please see "doc/security.txt" for directions on reporting security issues. |
|
49761be4a931
ADd reference to security.txt document.
John Rouillard <rouilj@ieee.org>
parents:
4812
diff
changeset
|
80 |
| 7708 | 81 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
82 Usage and Other Information |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
83 =========================== |
| 7708 | 84 |
|
4812
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
85 Start with the index.txt file in the "doc" directory. These |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
86 documentation files are written in reStructedText, which can be |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
87 converted into HTML format. If you have Sphinx installed, you can |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
88 do this by running:: |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
89 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
90 python setup.py build_doc |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
91 |
|
bbfc87ecfdf1
Update README.txt, explain Tracker Home, improve doc
anatoly techtonik <techtonik@gmail.com>
parents:
4702
diff
changeset
|
92 Resulting HTML files will be in "share/doc/roundup/html" directory. |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
93 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
94 |
| 7708 | 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. | |
|
4563
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
107 |
|
ef3e3c5e3501
Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents:
4092
diff
changeset
|
108 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
109 License |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
646
diff
changeset
|
110 ======= |
| 7708 | 111 See COPYING.txt. |
| 112 | |
| 113 tl;dr MIT, Zope version 2, Python Software Foundation version 2 |