X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=cbe951ba41d424f3d66462283cd4d735e48635b7;hb=8472b6be89f579eb5f9d52a90250df0e8ac4acde;hp=ee33a7e4c5049f05b8956a874d78df8470e954ee;hpb=e320a0bc3f6a40cf7b6c7cd2e708de419dc4006c;p=apps%2Flow-level-can-service.git

diff --git a/README.md b/README.md
index ee33a7e..cbe951b 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,53 @@
 # Low level CAN signaling binder
 
-Low level CAN bus binder. Based upon OpenXC vi-firmware project.
+Low level CAN bus binder, based upon OpenXC vi-firmware project.
 
-# Getting started
+Full document can be found under `docs` directory.
 
-This repo make use of git submodule, make sure to execute the following commands :
+# Generate documentation
 
-    ~/CAN_Signaling$ git submodule init
-    ~/CAN_Signaling$ git submodule update
+## Prerequisites
 
-# Prerequirements
+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 install doxygen graphviz
+```
+
+Prepare your build environment:
+
+```bash
+mkdir build && cd build
+cmake ..
+```
+
+## Generation
+
+Generate a PDF version :
+
+```bash
+gendocs.sh pdf
+```
+
+Serve an HTML version, this will run a web server that will serve you locally documentation :
+
+```bash
+gendocs.sh serve
+```
+
+Generate doxygen documentation:
+
+```bash
+gendocs.sh doxygen
+```
+or
+```bash
+cd build && make doxygen
+```