Skip to content

Commit b8020a8

Browse files
committed
Add virtualenv instant gratification
suggested by jerrykan.
1 parent 6b18486 commit b8020a8

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

website/www/index.txt

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,18 +149,48 @@ Roundup ships with a **demo tracker** to play with - you don't need to
149149
install Roundup. After you've unpacked the source, just run "``python
150150
demo.py``" and load up the URL it prints out!
151151

152-
To create a source directory and run the demo follow these simple
153-
steps (change the ``-2.2.0`` version identifier to match your downloaded
154-
file).
152+
You can install using a virtual environment with pip by:
155153

156-
1. ``python -m pip download roundup``
154+
1. create a virtual environment with::
155+
156+
python3 -m venv roundup
157+
158+
2. activate the environment with (assuming your shell is
159+
sh/bash/zsh/ksh like)::
160+
161+
. roundup/bin/activate
162+
163+
3. install the latest release of Roundup with::
164+
165+
python3 -m pip install roundup
166+
167+
4. create a demo tracker with::
168+
169+
roundup-demo
170+
171+
using ``./demo`` as the directory and the ``classic`` tracker.
172+
173+
5. load the URL printed by the demo tracker
174+
175+
6. when you are done, use `deactivate` to return your shell to using
176+
the system python.
177+
178+
Or choose the shorter source directory gratification to run the demo
179+
with these steps (change the ``-2.2.0`` version identifier to match
180+
your downloaded file).
181+
182+
1. ``python3 -m pip download roundup``
157183
2. ``tar -xzvf roundup-2.2.0.tar.gz``
158184

159185
* if you don't have a tar command, ``python -c 'import tarfile, sys; tarfile.open(sys.argv[1]).extractall();' roundup-2.2.0.tar.gz`` can be used.
160186

161187
3. ``cd roundup-2.2.0``
162-
4. ``python demo.py``
163-
188+
4. ``python3 demo.py``
189+
190+
Both of these methods produce the same result.
191+
192+
(The source download can also be used to create a Docker image.)
193+
164194
Origin Story
165195
============
166196
Roundup was originally released as version 0.1.1 in late August, 2001.

0 commit comments

Comments
 (0)