Code

Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
[roundup.git] / doc / announcement.txt
1 ====================================================
2 SC-Track Roundup 0.4.2pr1 - an issue tracking system
3 ====================================================
5 NOTE: This is the first (and hopefully only) pre-release of 0.4.2. If you
6 have an existing roundup installation and wish to test it, make a backup
7 of your database. Make sure you read the upgrading.txt document!
9 Roundup requires python 2.1.1 for correct operation. Support for dumbdbm
10 requires python 2.1.2 or 2.2. 2.1.3 and 2.2.1 are recommended.
12 Big stuff in this release:
14 - online demo at http://mechanicalcat.net/cgi-bin/roundup.cgi
15 - fast full-text searching of messages
16 - other speedups
17 - bsddb3 backend is re-enabled
18 - instance initialisation is a two-step process now, making mods easier
19 - optionally auto-add the author and recipients of messages to the nosy
20 - enhancements to make multilink editing through the web and email easier
21 - cleaner use of auditors and reactors in the default schemas
22 - demo scripts supplied in the scripts/ and detectors/ directories
23 - Much, much more: see the CHANGES file for details
25 Source and documentation is available at the website:
26      http://roundup.sourceforge.net/
27 Release Info (via download page):
28      http://sourceforge.net/projects/roundup
29 Mailing lists - the place to ask questions:
30      http://sourceforge.net/mail/?group_id=31577
34 About Roundup
35 =============
37 Roundup is a simple-to-use and -install issue-tracking system with 
38 command-line, web and e-mail interfaces. It is based on the winning design 
39 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
41 Note: Ping is not responsible for this project. The contact for this project 
42 is richard@users.sourceforge.net.
44 Roundup manages a number of issues (with flexible properties such as 
45 "description", "priority", and so on) and provides the ability to:
47 (a) submit new issues,
48 (b) find and edit existing issues, and
49 (c) discuss issues with other participants.
51 The system will facilitate communication among the participants by managing
52 discussions and notifying interested parties when issues are edited. One of
53 the major design goals for Roundup that it be simple to get going. Roundup
54 is therefore usable "out of the box" with any python 2.0+ installation. It
55 doesn't even need to be "installed" to be operational, though a
56 disutils-based install script is provided.
58 It comes with two issue tracker templates and three database back-ends.