summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGarret Fick <garret@ficksworkshop.com>2016-07-16 15:49:48 +0800
committerGarret Fick <garret@ficksworkshop.com>2016-07-16 15:49:48 +0800
commit52c6d4928a1b5fc65b95cf5b0784a560cec2ca1d (patch)
tree7e117c69b2c2310926bf677f719bb7406c2e3e43 /README.md
parent09ebeb6e244ff91f20e1813bca51102fd2e1077f (diff)
downloadgerbonara-52c6d4928a1b5fc65b95cf5b0784a560cec2ca1d.tar.gz
gerbonara-52c6d4928a1b5fc65b95cf5b0784a560cec2ca1d.tar.bz2
gerbonara-52c6d4928a1b5fc65b95cf5b0784a560cec2ca1d.zip
Fix most broken tests so that I can safely merge into changes with known expected test result
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 098b704..d33fa13 100644
--- a/README.md
+++ b/README.md
@@ -33,3 +33,18 @@ Source code for this example can be found [here](examples/cairo_example.py).
Documentation:
--------------
[PCB Tools Documentation](http://pcb-tools.readthedocs.org/en/latest/)
+
+
+Development and Testing:
+------------------------
+
+Dependencies for developing and testing pcb-tools are listed in test-requirements.txt. Use of a virtual environment is strongly recommended.
+
+ $ virtualenv venv
+ $ source venv/bin/activate
+ (venv)$ pip install -r test-requirements.txt
+ (venv)$ pip install -e .
+
+We use nose to run pcb-tools's suite of unittests and doctests.
+
+ (venv)$ nosetests