aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4fb764df..16e91c94 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,20 @@ patches and commit messages.
User and API [documentation][6] is automatically generated using [Sphinx][7]
and [Read the Docs][8].
+To generate HTML documents locally, install dependencies using
+
+```
+pip install -r requirements.txt
+```
+
+and run
+
+```
+make
+```
+
+Please run `make test` before sending a [pull request][0]
+
### Wiki
* [How to write a plugin][1]