Skip to content
Snippets Groups Projects
Commit 1c9b41d7 authored by Baptiste Bauvin's avatar Baptiste Bauvin
Browse files

Update readme

parent a4331f5c
No related branches found
No related tags found
No related merge requests found
......@@ -78,10 +78,24 @@ To run the test suite of SuMMIT, run :
.. code:: bash
cd path/to/summit
pip install -e .[dev]
pytest
The coverage report is automatically generated and stored in the ``htmlcov/`` directory
Building the documentation
<<<<<<<<<<<<<<<<<<<<<<<<<<
To locally build the `documentation <http://baptiste.bauvin.pages.lis-lab.fr/summit/index.html>`_ run :
.. code:: bash
cd path/to/summit
pip install -e .[doc]
python setup.py build_sphinx
The built html files will be stored in ``path/to/summit/build/sphinx/html``
Running on simulated data
<<<<<<<<<<<<<<<<<<<<<<<<<
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment