Code

- document experience from release(s)
[roundup.git] / doc / announcement.txt
1 I'm proud to release version 1.4.XX of Roundup which introduces some
2 minor features and, as usual, fixes some bugs:
4 Features:
6 - Norwegian Bokmal translation by Christian Aastorp
7 - Allow to specify additional cc and bcc emails (not roundup users) for
8   nosymessage used by the nosyreaction reactor. (Ralf)
10 Fixed:
12 - Fix file-unlink bug in mailgw (Ralfs oversight when refactoring the mail
13   gateway code) -- if a message is sent that contains no attachments,
14   all previous files of the issue are unlinked, thanks to Rafal
15   Bisingier for reporting and proposing a fix.
16   I've now added a regression test that catches this issue.
18 If you're upgrading from an older version of Roundup you *must* follow
19 the "Software Upgrade" guidelines given in the maintenance documentation.
21 Roundup requires python 2.4 or later (but not 3+) for correct operation.
23 To give Roundup a try, just download (see below), unpack and run::
25     roundup-demo
27 Release info and download page:
28      http://cheeseshop.python.org/pypi/roundup
29 Source and documentation is available at the website:
30      http://roundup-tracker.org/
31 Mailing lists - the place to ask questions:
32      http://sourceforge.net/mail/?group_id=31577
35 About Roundup
36 =============
38 Roundup is a simple-to-use and -install issue-tracking system with
39 command-line, web and e-mail interfaces. It is based on the winning design
40 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
42 Note: Ping is not responsible for this project. The contact for this
43 project is richard@users.sourceforge.net.
45 Roundup manages a number of issues (with flexible properties such as
46 "description", "priority", and so on) and provides the ability to:
48 (a) submit new issues,
49 (b) find and edit existing issues, and
50 (c) discuss issues with other participants.
52 The system will facilitate communication among the participants by managing
53 discussions and notifying interested parties when issues are edited. One of
54 the major design goals for Roundup that it be simple to get going. Roundup
55 is therefore usable "out of the box" with any python 2.4+ (but not 3+)
56 installation. It doesn't even need to be "installed" to be operational,
57 though an install script is provided.
59 It comes with two issue tracker templates (a classic bug/feature tracker and
60 a minimal skeleton) and four database back-ends (anydbm, sqlite, mysql
61 and postgresql).