view README.txt @ 4702:3dc458554d68

issue2550774: Fix generation of documentation - sphinx has replaced rst2html to generate the documentation, so the rst2html stuff is removed, and update the README - add the missing sphinx docs/conf.py file to the MANIFEST
author John Kristensen <john@jerrykan.com>
date Sun, 16 Dec 2012 13:10:52 +1100
parents ef3e3c5e3501
children bbfc87ecfdf1
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 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

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