Mercurial > p > roundup > code

annotate README.txt @ 4652:dfbc0cfa9811

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add an interface to register clearCache callbacks in roundupdb. Sometimes complicated computations may require an application cache. This application can now register a callback to clear the application cache, because roundup knows better when to clear it (usually when a transaction ends, either with rollback or with commit). The interface for this is currently considered experimental. The current interface is registerClearCacheCallback(self, method, param) where method is called with param as the only parameter.
author Ralf Schlatterbeck <rsc@runtux.com>
date Fri, 17 Aug 2012 15:30:36 +0200
parents ef3e3c5e3501
children 3dc458554d68
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
4092
4b0ddce43d08 migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents: 3949
diff changeset
5 Copyright (c) 2003-2009 Richard Jones (richard@mechanicalcat.net)
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
6 Copyright (c) 2002 eKit.com Inc (http://www.ekit.com/)
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
7 Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
8
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
9
1639
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
10 INSTANT GRATIFICATION
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
11 =====================
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
12
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
13 The impatient may try Roundup immediately by typing at the console::
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
14
1640
d0b29215aa44 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 1639
diff changeset
15 python demo.py
1639
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
16
1640
d0b29215aa44 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 1639
diff changeset
17 To start anew (a fresh demo instance)::
d0b29215aa44 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 1639
diff changeset
18
d0b29215aa44 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 1639
diff changeset
19 python demo.py nuke
1639
aa4a2b96a472 insto-mode
Richard Jones <richard@users.sourceforge.net>
parents: 1576
diff changeset
20
3723
e0d13120a330 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 3646
diff changeset
21 Run demo.py from the *source* directory; don't try to run demo.py from
3646
3a9a6b98c6e6 note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents: 1640
diff changeset
22 the *installed* directory, it will *break*.
3a9a6b98c6e6 note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents: 1640
diff changeset
23
3a9a6b98c6e6 note about where to run demo.py from
Richard Jones <richard@users.sourceforge.net>
parents: 1640
diff changeset
24
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
25 Installation
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
26 ============
791
668828091533 Mention upgrading.txt in the README, remove refs to the nonexistant HTML.
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
27 For installation instructions, please see installation.txt in the "doc"
668828091533 Mention upgrading.txt in the README, remove refs to the nonexistant HTML.
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
28 directory.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
30
796
5324a28060ab *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 791
diff changeset
31 Upgrading
5324a28060ab *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 791
diff changeset
32 =========
791
668828091533 Mention upgrading.txt in the README, remove refs to the nonexistant HTML.
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
33 For upgrading instructions, please see upgrading.txt in the "doc" directory.
4092
4b0ddce43d08 migrate from MimeWriter to email
Richard Jones <richard@users.sourceforge.net>
parents: 3949
diff changeset
34
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1409
diff changeset
35
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
36 Usage and Other Information
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
37 ===========================
791
668828091533 Mention upgrading.txt in the README, remove refs to the nonexistant HTML.
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
38 See the index.txt file in the "doc" directory.
3949
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3723
diff changeset
39 The *.txt files in the "doc" directory are written in reStructedText. If
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3723
diff changeset
40 you have rst2html installed (part of the docutils suite) you can convert
29dfb873b32e Small documentation cleanup
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3723
diff changeset
41 these to HTML by running "make html" in the "doc" directory.
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
42
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
43
4563
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
44 For Developers
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
45 ==============
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
46 To get started on development work, read the developers.txt file in
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
47 the "doc" directory.
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
48
ef3e3c5e3501 Point new developers at the developers,txt file.
Eric S. Raymond <esr@thyrsus.com>
parents: 4092
diff changeset
49
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
50 License
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
51 =======
1409
8dc60d87ab42 Fixed a backlog of bug reports, and worked on python 2.3 compatibility:
Richard Jones <richard@users.sourceforge.net>
parents: 1071
diff changeset
52 See COPYING.txt
Roundup Issue Tracker: http://roundup-tracker.org/