X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=2637f7f811213476bfa978a54188f0a0a2473231;hb=94e5f493282c2a399d8ad2471604f50975560fc0;hp=cbe951ba41d424f3d66462283cd4d735e48635b7;hpb=67f11e0fa62906f3c9a68b46c1d74aef8109d15d;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index cbe951ba..2637f7f8 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,16 @@ -# 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. Full document can be found under `docs` directory. -# Generate documentation +# Fast build procedure -## 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: +Just use autobuild script: ```bash -mkdir build && cd build -cmake .. +./conf.d/autobuild/agl/autobuild build +./conf.d/autobuild/agl/autobuild package ``` -## 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 -``` +This will build both projects under build directory for each of them with default configuration.