Add HACKING

1 files changed, 39 insertions, 0 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..208564d
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,39 @@
+-*- mode: rst; coding: utf-8;  -*-
+
+HACKING
+=======
+
+See TODO for list of things that needs to be done.
+
+Setting up the environment
+--------------------------
+
+First setup virtual environment::
+
+   cd markdown-link-style
+   virtualenv --python=python3.5 .
+
+Activate virtual environment::
+
+   source bin/activate
+
+Install dependencies::
+
+   pip install -r requirements.txt
+   python setup develop
+
+Running tests
+-------------
+
+Run all tests::
+
+   nosetests -sv
+
+
+Run a particular test class::
+
+   nosetests -sv tests.module_name:TestClassName
+
+Run a particular test in a test class::
+
+   nosetests -sv tests.module_name:TestClasseName.test_method_name