summaryrefslogtreecommitdiffstats
path: root/utils/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'utils/README.md')
-rw-r--r--utils/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/utils/README.md b/utils/README.md
new file mode 100644
index 000000000..bead4c44f
--- /dev/null
+++ b/utils/README.md
@@ -0,0 +1,37 @@
+# Running Tests (NEW)
+
+Run the command:
+
+ make ci
+
+to run an array of unittests locally.
+
+# Running From Source
+
+You will need to setup a **virtualenv** to run from source:
+
+ $ virtualenv oo-install
+ $ source ./oo-install/bin/activate
+ $ virtualenv --relocatable ./oo-install/
+ $ python setup.py install
+
+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
+
+# Testing (OLD)
+
+*This section is deprecated, but still works*
+
+First, run the **virtualenv setup steps** described above.
+
+Install some testing libraries: (we cannot do this via setuptools due to the version virtualenv bundles)
+
+$ pip install mock nose
+
+Then run the tests with:
+
+$ oo-install/bin/nosetests