X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=4d9892f879d55b60333f14debb1117b91a84ca38;hb=3e6d3fa8be349b40d6fd03d198b5e033cc7719e2;hp=ee33a7e4c5049f05b8956a874d78df8470e954ee;hpb=0c9926d385f357e4a0a8bb2932da0aa6e2503b9b;p=apps%2Fagl-service-can-low-level.git

diff --git a/README.md b/README.md
index ee33a7e4..4d9892f8 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,64 @@
-# Low level CAN signaling binder
+# CAN signaling binder
 
-Low level CAN bus binder. Based upon OpenXC vi-firmware project.
+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 :
+# Fast build procedure
 
-    ~/CAN_Signaling$ git submodule init
-    ~/CAN_Signaling$ git submodule update
+Just use autobuild script:
 
-# Prerequirements
+```bash
+./conf.d/autobuild/agl/autobuild build
+./conf.d/autobuild/agl/autobuild package
+```
+
+This will build both projects under build directory for each of them with default configuration.
+
+# 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 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
+```