view README.txt @ 5604:ed02a1e0aa5d REST-rebased

Fix actions Permission for retire in roundup/actions.py was with 'Edit' permission, not 'Retire' permission. Add a 'restore' action to roundup/actions.py. Both are now correctly used in rest.py and xmlrpc.py (the latter had some errors when printint error messages). Also reworked the rest implementation: Despite the warnings in the roundup API in hyperdb.py the DELETE http method would *destroy* and not *retire* an item. This has been fixed. We also do not allow retire of a complete class (although this was implemented) because this seems to dangerous and we see no use-case.
author Ralf Schlatterbeck <rsc@runtux.com>
date Wed, 30 Jan 2019 14:12:27 +0100
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/