summaryrefslogtreecommitdiffstats
path: root/utils/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'utils/README.md')
-rw-r--r--utils/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/utils/README.md b/utils/README.md
new file mode 100644
index 000000000..79ea3fa9f
--- /dev/null
+++ b/utils/README.md
@@ -0,0 +1,18 @@
+# Running Tests
+
+All tests can be run by running `tox`. See [running tests](..//CONTRIBUTING.md#running-tests) for more information.
+
+# Running From Source
+
+You will need to setup a **virtualenv** to run from source:
+
+ $ virtualenv oo-install
+ $ source oo-install/bin/activate
+ $ python setup.py develop
+
+The virtualenv `bin` directory should now be at the start of your
+`$PATH`, and `oo-install` is ready to use from your shell.
+
+You can exit the virtualenv with:
+
+ $ deactivate