Add README on building docs

2016-03-05 18:42:05 +01:00 · 2016-03-05 18:42:05 +01:00 · 36c8af3fe1
parent cbcf779dc2
commit 36c8af3fe1
1 changed files with 19 additions and 0 deletions
--- a/docs/README.txt
+++ b/docs/README.txt
@ -0,0 +1,19 @@
+Building the docs
+=================
+
+First install Sphinx:
+
+    pip install sphinx
+
+Then build:
+
+    cd docs && make html
+
+To build the man page:
+
+    make man
+
+Then:
+
+    rm man/glances.1
+    cp _build/man/glances.1 man/glances.1