add readme steps for maintainers

1 files changed, 35 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index ad1449e..a2dd04c 100644
--- a/README.rst
+++ b/README.rst
@@ -50,3 +50,38 @@ Take a look at the ``demos`` to see what's possible.
 
 
 .. _`documentation`: https://ansicolor.readthedocs.org/
+
+
+
+Maintenance tasks
+-----------------
+
+
+Setting up a development environment (Ubuntu)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+    # if you don't have `mkvirtualenv` & `workon` functions in your shell
+    $ sudo apt install virtualenvwrapper
+
+    $ mkvirtualenv ansicolor
+    (ansicolor) $ pip install -r dev-requirements.txt
+
+
+Running tests
+^^^^^^^^^^^^^
+
+.. code:: bash
+
+    $ py.test
+
+
+Measuring code coverage
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: bash
+
+    $ py.test --cov=ansicolor
+    $ coverage html
+    # open htmlcov/index.html in the browser
\ No newline at end of file