Code

merge from maintenance branch
[roundup.git] / doc / announcement.txt
1 =================================================
2 SC-Track Roundup 0.5.0 - an issue tracking system
3 =================================================
5 Note: If you are upgrading, you *must* read doc/upgrading.txt!
7 Roundup requires python 2.1.1 for correct operation. Support for dumbdbm
8 requires python 2.1.2 or 2.2. 2.1.3 and 2.2.1 are recommended.
10 A lot has been done since 0.4.4:
12 - new backend for metakit (thanks Gordon McMillan)
13 - new backend for sqlite
14 - new backend for gadfly (it's as done as it's going to get)
15 - added Boolean and Number types
16 - fixed the journal bloat, re-enabling useful link journal events
17 - full-text search may also search certain String properties
18 - entire database export and import (including files)
19 - implemented new per-user access control mechanisms (Permissions, Roles)
20 - switched templating to use Zope's PageTemplates giving much more flexibility
21 - made web interface more generic, robust, give nicer errors, ...
22 - revamped look and feel in web interface including cleaned up CSS usage
23 - switched to cookie-based sessions for web authentication
24 - saving of named search queries
25 - lots of documentation cleanups including an updated customisation document
26   with los of examples and a new maintenance guide
27 - roundup-server may be a daemon now (fork, logfile, pidfile)
28 - many, many more bug fixes, cleanups and minor improvements (see CHANGES.txt)
30 This final 0.5.0 release fixes the following problems:
32 - fixed style for alternating rows in user lists
33 - a couple of other minor bugs
34 - updated demo to use 0.5 codebase
36 Source and documentation is available at the website:
37      http://roundup.sourceforge.net/
38 Release Info (via download page):
39      http://sourceforge.net/projects/roundup
40 Mailing lists - the place to ask questions:
41      http://sourceforge.net/mail/?group_id=31577
44 About Roundup
45 =============
47 Roundup is a simple-to-use and -install issue-tracking system with 
48 command-line, web and e-mail interfaces. It is based on the winning design 
49 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
51 Note: Ping is not responsible for this project. The contact for this project 
52 is richard@users.sourceforge.net.
54 Roundup manages a number of issues (with flexible properties such as 
55 "description", "priority", and so on) and provides the ability to:
57 (a) submit new issues,
58 (b) find and edit existing issues, and
59 (c) discuss issues with other participants.
61 The system will facilitate communication among the participants by managing
62 discussions and notifying interested parties when issues are edited. One of
63 the major design goals for Roundup that it be simple to get going. Roundup
64 is therefore usable "out of the box" with any python 2.1+ installation. It
65 doesn't even need to be "installed" to be operational, though a
66 disutils-based install script is provided.
68 It comes with two issue tracker templates (a classic bug/feature tracker and
69 a minimal skeleton) and six database back-ends (anydbm, bsddb, bsddb3, sqlite,
70 metakit and gadfly).