diff options
author | Siddharth Ravikumar <sravik@bgsu.edu> | 2015-12-22 15:21:13 -0500 |
---|---|---|
committer | Siddharth Ravikumar <sravik@bgsu.edu> | 2015-12-22 15:21:13 -0500 |
commit | 9c9988f28a8a0efb444a63827476b16fdf3cfa10 (patch) | |
tree | cc1c82acadd6b299b525cedfb1dabc3d9a7364ba /docs/setup-combox.rst | |
parent | 22335fc4e71de5c4ceefbd5e502a15ad285740cf (diff) |
Added docs/ (uses sphinx).
Most of what was in README.rst was moved to docs/
Diffstat (limited to 'docs/setup-combox.rst')
-rw-r--r-- | docs/setup-combox.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/setup-combox.rst b/docs/setup-combox.rst new file mode 100644 index 0000000..d189d67 --- /dev/null +++ b/docs/setup-combox.rst @@ -0,0 +1,28 @@ +============= +setup combox +============= + +.. highlight:: bash + +Get the latest copy of combox:: + + $ git clone git://ricketyspace.net/combox.git + +Setup virtual environment:: + + $ cd combox + $ virtualenv . + +Activate the virtual environment:: + + $ source bin/activate + +Install combox in ``develop`` mode:: + + $ python setup.py develop + +Always make sure that the virtual environment is activated before +running combox. To activate virtual environment, do:: + + $ cd path/to/combox + $ source bin/activate |