From 126bcceaeecdee143264286a1d5a0ad3b5cdb31d Mon Sep 17 00:00:00 2001 From: Patrick Watrin <pat@lucy.local> Date: Tue, 1 Mar 2016 09:33:11 +0100 Subject: [PATCH] documentation building instruction --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bbfbed3..3fdb8b3 100644 --- a/README.md +++ b/README.md @@ -116,12 +116,16 @@ port install py35-sphinx apt-get install python-sphinx ``` -Once the tool installed, just open a terminal, move in the [documentation]() directory and run (as user): +Once the tool is installed, open a terminal, move in the [documentation]() directory and run (as user): ```bash +# If necessary, clean previous build +make clean make html ``` +After the compilation process, the resulting files are located in `_build/html/`. + ## Getting started **NOTE: The texts must be encoded in UTF-8. There is so far no support for UTF-16-(LE|BE) or any other encoding.** -- GitLab