summaryrefslogtreecommitdiffstats
path: root/docs/README.txt
diff options
context:
space:
mode:
authorAlessio Sergi <al3hex@gmail.com>2016-03-05 18:42:05 +0100
committerAlessio Sergi <al3hex@gmail.com>2016-03-06 19:16:37 +0100
commit36c8af3fe1984fa832d5fa0004587876b8201bf9 (patch)
treede423e7e456914afe3b6c37594de3fe780804b7a /docs/README.txt
parentcbcf779dc227eb7fbd872af0d2c171a934999a12 (diff)
Add README on building docs
Diffstat (limited to 'docs/README.txt')
-rw-r--r--docs/README.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/README.txt b/docs/README.txt
new file mode 100644
index 00000000..38f26fb7
--- /dev/null
+++ 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