Clean unused project files and update build script

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

diff --git a/README.md b/README.md
index bcf9981..a608363 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,23 @@
-# 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.
+
+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.
+
 # Generate documentation
 
 ## Prerequisites
@@ -18,7 +32,7 @@ sudo apt-get install calibre
 To generate Doxygen documentation, you'll need doxygen and graphviz:
 
 ```bash
-sudo apt-get doxygen graphviz
+sudo apt-get install doxygen graphviz
 ```
 
 Prepare your build environment:
@@ -33,17 +47,21 @@ cmake ..
 Generate a PDF version :
 
 ```bash
-make pdf
+gendocs.sh pdf
 ```
 
 Serve an HTML version, this will run a web server that will serve you locally documentation :
 
 ```bash
-make serve
+gendocs.sh serve
 ```
 
 Generate doxygen documentation:
 
 ```bash
-make doxygen
-```
\ No newline at end of file
+gendocs.sh doxygen
+```
+or
+```bash
+cd build && make doxygen
+```