Mercurial > p > roundup > code
view README.txt @ 5695:3e1b66c4e1e2
Update docs. Correct errors reported by setup.py build_docs. Add rest
interface and link to rest doc to features page. Add link to xmlrpc
doc to features page. Add rest doc to index. Update rest doc,
hopefully clarify confusing use of parameters in patch action
section. Fix code examples in "Adding new rest endpoints" section. Fix
example adding import of exception.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 Apr 2019 20:17:52 -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