X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=2637f7f811213476bfa978a54188f0a0a2473231;hb=cc22c89b2362f14e18d8d8ef2b736800592cfd1a;hp=55fc453e1d90aa16d7db930a76c331a800d2be9b;hpb=db3dea9a59746b26b966b022d046ec8e44c37539;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index 55fc453e..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 doxygen graphviz -``` - -Prepare your build environment: - -```bash -mkdir build && cd build -cmake .. -``` - -## Generation - -Generate a PDF version : +Just use autobuild script: ```bash -gendocs.sh pdf +./conf.d/autobuild/agl/autobuild build +./conf.d/autobuild/agl/autobuild package ``` -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 -``` \ No newline at end of file +This will build both projects under build directory for each of them with default configuration.