view README.txt @ 5110:87b0358790ed

Adding some tests for admin.py. Specifically for issue2550572: setting nosy=+foo on multiple issues gives them all the same exact nosy list. To make this work had to change the admin.py code to use "sys.stdout.write" in place of "print". In the test I now hijack stdout.write following an existing example of this for admin's import/export command that hijacks sys.stderr.write. Also I corrected a misspelling in security.py. The word "everything" was misspelled. It is not inside _() markers so I don't think it's going to affect translation and grepping the locale subdir doesn't show the original string.
author John Rouillard <rouilj@ieee.org>
date Wed, 29 Jun 2016 18:35:19 -0400
parents bbfc87ecfdf1
children 49761be4a931
line wrap: on
line source

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

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

The impatient may try Roundup immediately by running demo.py from
the source directory::

   python demo.py

This will create new tracker home in "demo" subdirectory and start
server. To reset demo instance::

   python demo.py nuke


Tracker Home
=============
"Tracker Home" is main concept when starting with Roundup. It is
directory where all your tracker data is stored. This directory is
created every time when new tracker is initialized and includes
tracker configuration, database, template, schema and extensions.


Installation
============
Please see "doc/installation.txt"


Upgrading
=========
Please see "doc/upgrading.txt"


Usage and Other Information
===========================
Start with the index.txt file in the "doc" directory. These
documentation files are written in reStructedText, which can be
converted into HTML format. If you have Sphinx installed, you can
do this by running::

   python setup.py build_doc

Resulting HTML files will be in "share/doc/roundup/html" 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/