Mercurial > p > roundup > code
view README.txt @ 7687:4dda4a9dfe0b
doc: add comment on method to set savepoint_limit dynamically
savepoint_limit isn't a real config option as in config.ini. I
generate one on the fly for use in the backend during import.
While this is arguably a valid config option, it is also something
that is niche (import a tracker to postgres) and adds clutter to
config.ini.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 29 Oct 2023 13:18:36 -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