X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=1629ffbcd1a34c45ec737aa0cebd9f901706f907;hb=ad1a743a6eba4fcc94ac5fee591c46b92ce1b0ac;hp=9c0daaffa698f1b98c7824a3d124e886908a42d7;hpb=00655ea12cc870b84291e462ff791461cc500d68;p=apps%2Fagl-service-can-low-level.git

diff --git a/README.md b/README.md
index 9c0daaff..1629ffbc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,67 @@
-# can-config-generator
\ No newline at end of file
+# CAN signaling binder
+
+CAN bus binder, based upon OpenXC vi-firmware project.
+
+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.
+
+Full document can be found under `docs` directory.
+
+# Fast build procedure
+
+Just use build.sh script:
+
+```bash
+./build.sh
+```
+
+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
+```