X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=1629ffbcd1a34c45ec737aa0cebd9f901706f907;hb=0ac88a39962a3f723fcb5a07c4eb5c6d19e585f9;hp=3ae3775bbae005da22ad7a742bf6c3b589b0882b;hpb=b4bdf4e1ecdf99d8ecb0f13a99605aa10154169a;p=apps%2Fagl-service-can-low-level.git

diff --git a/README.md b/README.md
index 3ae3775b..1629ffbc 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,67 @@
-# OpenXC Message Format Specification
+# CAN signaling binder
 
-There are two valid message types - single valued and evented.
+CAN bus binder, based upon OpenXC vi-firmware project.
 
-There may not be a 1:1 relationship between input and output signals - i.e. raw
-engine timing CAN signals may be summarized in an "engine performance" metric on
-the abstract side of the interface.
+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.
 
-## Single Valued
+Full document can be found under `docs` directory.
 
-The expected format of a single valued message is:
+# Fast build procedure
 
-{% highlight javascript %}
-{"name": "steering_wheel_angle", "value": 45}
-{% endhighlight %}
+Just use build.sh script:
 
-## Evented
+```bash
+./build.sh
+```
 
-The expected format of an event message is:
+This will build both projects under build directory for each of them with default configuration.
 
-{% highlight javascript %}
-{"name": "button_event", "value": "up", "event": "pressed"}
-{% endhighlight %}
+# Generate documentation
 
-This format is good for something like a button event, where there are two
-discrete pieces of information in the measurement.
+## 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
+```