view README.txt @ 4652:dfbc0cfa9811

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
line wrap: on
line source

=======================================================
Roundup: an Issue-Tracking System for Knowledge Workers
=======================================================

Copyright (c) 2003-2009 Richard Jones (richard@mechanicalcat.net)
Copyright (c) 2002 eKit.com Inc (http://www.ekit.com/)
Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)


INSTANT GRATIFICATION
=====================

The impatient may try Roundup immediately by typing at the console::

   python demo.py

To start anew (a fresh demo instance)::

   python demo.py nuke

Run demo.py from the *source* directory; don't try to run demo.py from
the *installed* directory, it will *break*.


Installation
============
For installation instructions, please see installation.txt in the "doc"
directory.


Upgrading
=========
For upgrading instructions, please see upgrading.txt in the "doc" directory.


Usage and Other Information
===========================
See the index.txt file in the "doc" directory.
The *.txt files in the "doc" directory are written in reStructedText. If
you have rst2html installed (part of the docutils suite) you can convert
these to HTML by running "make html" in the "doc" directory.


For Developers
==============
To get started on development work, read the developers.txt file in
the "doc" directory.


License
=======
See COPYING.txt

Roundup Issue Tracker: http://roundup-tracker.org/