summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaulo Henrique Silva <ph.silva@gmail.com>2016-11-16 23:54:09 -0200
committerGitHub <noreply@github.com>2016-11-16 23:54:09 -0200
commit521fe89150c6aaa0ff0954cc8d32e4b6f8009324 (patch)
tree59cef68f1449a5be8d2a9a8ed352e3d9974a3edb /README.md
parent7030eee5e28180732c5cf98aeda4b66657223870 (diff)
parent1e868763a1c4030bedd51553468cbe25f272bef9 (diff)
downloadgerbonara-521fe89150c6aaa0ff0954cc8d32e4b6f8009324.tar.gz
gerbonara-521fe89150c6aaa0ff0954cc8d32e4b6f8009324.tar.bz2
gerbonara-521fe89150c6aaa0ff0954cc8d32e4b6f8009324.zip
Merge pull request #58 from garretfick/merge-curtacircuitos
Epic merge from @garretfick Thanks a lot @garretfick and @hamiltonkibbe.
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 5e46b02..fae47e3 100644
--- a/README.md
+++ b/README.md
@@ -42,3 +42,18 @@ $ python setup.py install
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