From 1c9b41d761aca76f8a80f71c9a62130bfc20c1b2 Mon Sep 17 00:00:00 2001
From: Baptiste Bauvin <baptiste.bauvin@lis-lab.fr>
Date: Fri, 1 May 2020 14:21:08 -0400
Subject: [PATCH] Update readme
---
README.rst | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/README.rst b/README.rst
index 650b3a2c..ae56f162 100644
--- a/README.rst
+++ b/README.rst
@@ -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
<<<<<<<<<<<<<<<<<<<<<<<<<
--
GitLab