From 9c9988f28a8a0efb444a63827476b16fdf3cfa10 Mon Sep 17 00:00:00 2001
From: Siddharth Ravikumar <sravik@bgsu.edu>
Date: Tue, 22 Dec 2015 15:21:13 -0500
Subject: Added docs/ (uses sphinx).

Most of what was in README.rst was moved to docs/
---
 docs/setup-combox.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 docs/setup-combox.rst

(limited to 'docs/setup-combox.rst')

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
-- 
cgit v1.2.3