From d32b0760ee2184ee6281e40d134aacbc5d395f77 Mon Sep 17 00:00:00 2001 From: Romain Forlot Date: Mon, 20 Mar 2017 12:44:45 +0000 Subject: Add targets to build documentation with instructions. Change-Id: I037ab5d94e17147aba998131e92c1ec920293fa9 Signed-off-by: Romain Forlot --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f346327..bcf9981 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,47 @@ Low level CAN bus binder, based upon OpenXC vi-firmware project. Full document can be found under `docs` directory. -Note that your can use gitbook to serve documentation: + +# Generate documentation + +## Prerequisites + +You can use gitbook to serve documentation. To do so, please install it using *npm* as well as *calibre* package from your package distribution manager: + +```bash +sudo npm install -g gitbook-cli +sudo apt-get install calibre +``` + +To generate Doxygen documentation, you'll need doxygen and graphviz: + +```bash +sudo apt-get doxygen graphviz ``` + +Prepare your build environment: + +```bash mkdir build && cd build cmake .. -make serve-docs +``` + +## Generation + +Generate a PDF version : + +```bash +make pdf +``` + +Serve an HTML version, this will run a web server that will serve you locally documentation : + +```bash +make serve +``` + +Generate doxygen documentation: + +```bash +make doxygen ``` \ No newline at end of file -- cgit 1.2.3-korg