view README.txt @ 5192:302e3a1a7190

Three sets of changes: 1) Make sure that a user doesn't create a query with the same name as an existing query that the user owns. 2) When submitting a new named query, display the name of the query on the index page. 3) Allow optional arguments to indexargs_url by setting their value to None. This will show the argument only if there is a valid value. To match these, changed the template for all search templates so if an error is thrown due to #1 the user stays on the search page so they can fix the issue. Note that I did not add automated tests for these because I couldn't find existing tests for these code paths that I could adapt. I don't understand how the existing Action tests work and there is no doc for them.
author rouilj@uland
date Wed, 08 Mar 2017 22:04:15 -0500
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/