Mercurial > p > roundup > code
view README.txt @ 7322:485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
Restructured docs.txt. Pulled out older documents into Old Docs.
I wish I could add whitespace between documents in the toc. Current
order split into groupings:
Roundup Features
Roundup Features
Installing Roundup
Upgrading to newer versions of Roundup
Reporting Security Issues with Roundup
Roundup FAQ
User Guide
Customising Roundup
REST API for Roundup
XML-RPC access to Roundup
Roundup Reference
Roundup Glossary
Administration Guide
License
Acknowledgements
Other Docs
debugging.txt removed. Its contents replaced a reference in
developer.txt.
Added olderdocs for:
docs/upgrading-history
docs/tracker_templates
Design Overview <docs/overview>
Design (original) <docs/design>
docs/developers
Notes about the MySQL Database backend <docs/mysql>
Notes about the PostgreSQL Database backend <docs/postgresql>
Richard Jones implementation notes <docs/implementation>
docs/security-history
to keep them out of the docs.txt sidebar.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 11 May 2023 13:50:57 -0400 |
| parents | 49761be4a931 |
| children | 1f6c77ee4b18 |
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" Security Issues =============== Please see "doc/security.txt" for directions on reporting security issues. 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