From 36716161568b457f526e16bc96675874147b5b78 Mon Sep 17 00:00:00 2001 From: Martijn Vermaat <martijn@vermaat.name> Date: Wed, 27 Aug 2014 23:06:52 +0200 Subject: [PATCH] Additional documentation on development mode installation --- doc/development.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/doc/development.rst b/doc/development.rst index 315db3c8..7566f7b9 100644 --- a/doc/development.rst +++ b/doc/development.rst @@ -24,10 +24,28 @@ In general, try to follow the `PEP 8`_ guidelines for Python code and `PEP 257`_ for docstrings. +Installation +------------ + +As a developer, you probably want to install the Mutalyzer package in +development mode. This will allow you to edit files directly in the source +directory without having to reinstall. + +Please refer to :ref:`install` for general installation instructions. For +development mode installation, instead of using ``python setup.py install``, +use:: + + python setup.py develop + + Unit tests ---------- -To run the unit tests with `pytest`_, just run ``py.test``. +We use `pytest`_ for the unit tests. To run them, just type ``py.test`` from +the Mutalyzer source directory. + +.. note:: The Mutalyzer package must be installed before running the unit + tests. Working with feature branches -- GitLab