Skip to content

Commit bdfe771

Browse files
committed
docs: update top level readme: user's guide; demo mode refs
Added link to really impatient section of insallation.txt that includes detailed directions on running demo mode. Included section referencing the user's guide. Renamed "Usage and Other Information" to "Other Information" with addition of usage section. Removed uneeded extra newline.
1 parent 01fd903 commit bdfe771

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.txt

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ a web server. To reset demo instance::
4141

4242
python demo.py nuke
4343

44+
For details see the "For the Really Impatient" section of the
45+
installation document at:
46+
47+
https://roundup-tracker.org/docs/installation.html#for-the-really-impatient
48+
49+
for details on running demo mode or using the docker demo mode.
4450

4551
Tracker Home
4652
------------
@@ -50,6 +56,12 @@ directory where all your tracker data is stored. This directory is
5056
created every time when new tracker is initialized and includes
5157
tracker configuration, database, template, schema and extensions.
5258

59+
Using Roundup
60+
=============
61+
62+
Please see the user's guide at:
63+
64+
https://roundup-tracker.org/docs/installation.html#for-the-really-impatient
5365

5466
Installation
5567
============
@@ -72,15 +84,14 @@ Upgrading
7284

7385
Please see "doc/upgrading.txt".
7486

75-
7687
Security Issues
7788
===============
7889

7990
Please see "doc/security.txt" for directions on reporting security issues.
8091

8192

82-
Usage and Other Information
83-
===========================
93+
Other Information
94+
=================
8495

8596
Start with the index.txt file in the "doc" directory. These
8697
documentation files are written in reStructedText, which can be

0 commit comments

Comments
 (0)