Adjust method signature to be more efficient.

[apps/low-level-can-service.git] / README.md

diff --git a/README.md b/README.md
index ee33a7e..a608363 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,67 @@
-# 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
+There are 2 separated projects here, one with the CAN-binder that is installed
+on an AGL target and the CAN config generator used to generate a source file for
+the low level binding.
 
-This repo make use of git submodule, make sure to execute the following commands :
+Full document can be found under `docs` directory.
 
-    ~/CAN_Signaling$ git submodule init
-    ~/CAN_Signaling$ git submodule update
+# Fast build procedure
 
-# Prerequirements
+Just use build.sh script:
+
+```bash
+./build.sh
+```
+
+This will build both projects under build directory for each of them.
+
+# 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
+```