view README.txt @ 6545:5a3a386aa8e7

issue2551179 Load config_ini.ini ... recognize minimal template demo.py Mostly taken from patch by John Kristensen (jerrykan). Tests for python3 and 2 created for minimal and jinja2 templates. Removed FIXME for special case config settings for jinja and responsive templates. config_ini.ini mechanism makes it obsolete. Demo removes config_ini.ini file in home directory. Also remove encoding of utf-8 from initial_data.py to remove SyntaxError: encoding declaration in Unicode string under python2.
author John Rouillard <rouilj@ieee.org>
date Thu, 09 Dec 2021 15:26:39 -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/