@@ -36,6 +36,46 @@ Roundup scripts
3636 These include the email gateway, the roundup
3737 HTTP server, the roundup administration command-line interface, etc.
3838
39+ For The Really Impatient
40+ ========================
41+
42+ If you just want to give Roundup a whirl Right Now, follow these
43+ directions to download, unpack and run ``demo.py``. (Replace
44+ ``-2.2.0`` with the version number of the file you downloaded. On
45+ systems that don't provide a ``python3`` program you can run
46+ ``python demo.py``.)
47+
48+ 1. ``python3 -m pip download roundup``
49+ 2. ``tar -xzvf roundup-2.2.0.tar.gz``
50+
51+ * if you don't have a tar command, ``python3 -c 'import tarfile, sys; tarfile.open(sys.argv[1]).extractall();' roundup-2.2.0.tar.gz`` can be used.
52+
53+ 3. ``cd roundup-2.2.0``
54+ 4. ``python3 demo.py``
55+
56+ This will set up a simple demo tracker on your machine. [1]_
57+ When it's done, it'll print out a URL to point your web browser at
58+ so you may start playing. Three users will be set up:
59+
60+ 1. anonymous - the "default" user with permission to do very little
61+ 2. demo (password "demo") - a normal user who may create issues
62+ 3. admin (password "admin") - an administrative user who has complete
63+ access to the tracker
64+
65+ Note the demo tracker removes the detector (nosyreaction.py) that
66+ sends email notifications. If you later convert your demo tracker to
67+ production you will need to copy in the detector to send notification
68+ emails.
69+
70+ If you install Roundup, the ``demo.py`` script is available as
71+ ``roundup-demo``.
72+
73+ .. [1] Demo tracker is set up to be accessed by localhost browser.
74+ If you run demo on a server host, please stop the demo (using
75+ Control-C) after it has shown the startup notice, open file
76+ ``demo/config.ini`` with your editor, change host name in
77+ the ``web`` option in section ``[tracker]``, save the file,
78+ then re-run the demo.py program.
3979
4080Prerequisites
4181=============
@@ -168,29 +208,6 @@ Getting Roundup
168208
169209Download the latest version from https://www.roundup-tracker.org/.
170210
171- For The Really Impatient
172- ========================
173-
174- If you just want to give Roundup a whirl Right Now, then simply unpack
175- and run ``demo.py`` (it will be available as ``roundup-demo`` script
176- after installation). (On systems that don't provide a ``python3``
177- program you might need to run ``python demo.py``.)
178-
179- This will set up a simple demo tracker on your machine. [1]_
180- When it's done, it'll print out a URL to point your web browser at
181- so you may start playing. Three users will be set up:
182-
183- 1. anonymous - the "default" user with permission to do very little
184- 2. demo (password "demo") - a normal user who may create issues
185- 3. admin (password "admin") - an administrative user who has complete
186- access to the tracker
187-
188- .. [1] Demo tracker is set up to be accessed by localhost browser.
189- If you run demo on a server host, please stop the demo when
190- it has shown startup notice, open file ``demo/config.ini`` with
191- your editor, change host name in the ``web`` option in section
192- ``[tracker]``, save the file, then re-run the demo.py program.
193-
194211Installation
195212============
196213
0 commit comments