Code

. Clean up mail handling, multipart handling.
[roundup.git] / README.txt
1                                     Roundup
2                                     =======
5 1. License
6 ==========
8 Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
9 This module is free software, and you may redistribute it and/or modify
10 under the same terms as Python, so long as this copyright message and
11 disclaimer are retained in their original form.
13 IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
14 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
15 OUT OF THE USE OF THIS CODE, EVEN IF BIZAR SOFTWARE PTY LTD HAS BEEN ADVISED
16 OF THE POSSIBILITY OF SUCH DAMAGE.
18 BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20 FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
21 BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
22 SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25 The stylesheet included with this package has been copied from the Zope
26 management interface and presumably belongs to Digital Creations.
29 2. Installation
30 ===============
31 For installation notes, please see the file INSTALL.TXT
34 3. Usage
35 ========
36 See the index.html file in the "doc" directory.
39 3. Design
40 =========
41 See the information in the "doc" directory.
45 4. TODO
46 =======
47 Most of the TODO items are captured in comments in the code. In summary:
49 in general:
50   . more unit tests
51   . more back-ends
52 hyperdb:
53   . more efficient reverse lookups
54 roundupdb:
55   . split the file storage into multiple dirs?
56 roundup-server:
57   . check the source file timestamps before reloading
58 cgi_client
59   . keep form fields in form on bad submission - only clear it if all ok
62 5. Known Bugs
63 =============
65 date:
66   . date subtraction doesn't work correctly "if the dates cross leap years,
67     phases of the moon, ..."
70 6. Author
71 =========
72 richard@users.sourceforge.net
75 7. Thanks
76 =========
77 Well, Ping, of course ;)
79 Anthony Baxter, for some good first-release feedback. And then continuing
80 support through development on sourceforge.