X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=42245cca29c30cc1622e9d6526d1c7e1adfd8a7d;hb=45514381c51ec65b1a2d05264a30a4d468348748;hp=bcf998191629f9d6919d4a7e4328a15d96ead72d;hpb=d32b0760ee2184ee6281e40d134aacbc5d395f77;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index bcf99819..42245cca 100644 --- a/README.md +++ b/README.md @@ -1,49 +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 : - -```bash -make pdf -``` - -Serve an HTML version, this will run a web server that will serve you locally documentation : +Just use autobuild script: ```bash -make serve +./autobuild/agl/autobuild build +./autobuild/agl/autobuild package ``` -Generate doxygen documentation: - -```bash -make doxygen -``` \ No newline at end of file +This will build both projects under build directory for each of them with default configuration.