summaryrefslogtreecommitdiffstats
path: root/HACKING.rst
diff options
context:
space:
mode:
authorrsiddharth <s@ricketyspace.net>2017-07-16 05:39:20 +0000
committerrsiddharth <s@ricketyspace.net>2017-07-16 05:42:29 +0000
commit40861fcbc949bf1f1835399f76e096192bccb319 (patch)
treee2ee5729af23f3d6dd7e41d7423dea808a40dca2 /HACKING.rst
Initial commit.
* .gitignore: New file. * CONTRIBUTORS: New file. * COPYING: New file. * HACKING.rst: New file. * Makefile: New file. * README.rst: New file. * markdown_textwrap/__init__.py: New file. * markdown_textwrap/_version.py: New file. * md_tw.py: New file. * requirements.txt: New file. * setup.py: New file. * tests/__init__.py: New file. * tests/test_md_tw.py: New file.
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst
new file mode 100644
index 0000000..e9f985d
--- /dev/null
+++ b/HACKING.rst
@@ -0,0 +1,37 @@
+-*- mode: rst; coding: utf-8; -*-
+
+HACKING
+=======
+
+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