Browse Source

Add the doc doc !

Jocelyn Delande 9 years ago
parent
commit
c57bc39504
1 changed files with 15 additions and 0 deletions
  1. 15 0
      README.md

+ 15 - 0
README.md

@@ -38,3 +38,18 @@ Use it
 - Enter data into (yeah, documentation can explain a bit better...)
   http://localhost:8000/admin/
 - Browse http://localhost:8000 to view costs/details
+
+
+Building documentation
+----------------------
+
+Doc is using mkdocs, located in *docs/* ; you can build it yourself.
+
+Install doc dependencies :
+
+    pip install -r requirements/doc.txt
+
+You can then build and serve it localy :
+
+    cd docs
+    mkdocs serve