File	Date	Author	Commit
.circleci	2018-08-17	Christof Meerwald	[851d43] added circleci configuration to test on Ubuntu ...
3rdparty	2014-01-30	Pradip Caulagi	[cf273c] Add instruction to actually build Bootstrap
detectors	2018-07-24	Joseph Myers	[23b8e6] Python 3 preparation: update calls to dict meth...
doc	2018-09-16	Joseph Myers	[bc3e00] MySQL backend fixes for Python 3.
frontends	2018-09-15	Joseph Myers	[e0c83b] Handle str/bytes issues for Python 3 for roundu...
locale	2018-10-23	Tobias Herp	[d88b91] Translations for the "responsive" template
roundup	2018-09-27	Joseph Myers	[901d7b] Avoid errors from invalid Authorization headers...
scripts	2018-09-16	Joseph Myers	[e124d7] Fix scripts/roundup-reminder for Python 3 (issu...
share	2018-10-09	John Rouillard	[0452fc] removing duplicate @csrf nonce.
test	2018-09-27	Joseph Myers	[fea11d] Avoid errors from selecting "no selection" on m...
tools	2018-08-30	Joseph Myers	[d7e6b1] Remove tools/pygettext.py (issue 2550977).
website	2018-10-09	John Rouillard	[4d32fa] Remove duplicate @csrf nonce from form. Duplica...
.coveragerc	2017-03-19	John Rouillard	[729e70] Added .coveragerc to exclude the dist utilites ...
.hgignore	2018-10-23	Tobias Herp	[153cf5] Directories and file to ignore for virtualenvs
.hgtags	2018-07-13	John Rouillard	[833941] Added tag 1.6.0 for changeset dc6cc2dbd70a
.travis.yml	2018-08-18	Joseph Myers	[ff5e3e] Also test with Python 3.5 and 3.6, don't allow ...
CHANGES.txt	2018-09-27	Joseph Myers	[901d7b] Avoid errors from invalid Authorization headers...
COPYING.txt	2018-07-06	John Rouillard	[3bd2be] `` in text was triggering warning of inline lit...
MANIFEST.in	2018-08-18	Joseph Myers	[c65284] Remove 2to3-done.txt (issue2550979).
README.txt	2013-08-24	anatoly techtonik	[bbfc87] Update README.txt, explain Tracker Home, improv...
RELEASE.txt	2018-08-30	Joseph Myers	[0036f4] Mention regenerating roundup.pot in release ins...
demo.py	2013-11-13	Thomas Arendsen Hein	[110ac4] executable .py scripts need "#!/usr/bin/env pyt...
run_tests.py	2016-06-27	John Kristensen	[07168a] Update run_tests.py to pytest v2.9.2
setup.py	2018-09-03	Joseph Myers	[df3f55] Update documentation for Python 3 support (issu...

Read Me

=======================================================
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