Source

tracker/roundup / README.txt

=======================================================
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 Sphinx installed, you can convert these to HTML by running
  $ python setup.py build_doc
from the top of the release directory.


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


License
=======
See COPYING.txt
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.