X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=2637f7f811213476bfa978a54188f0a0a2473231;hb=d1530f94446bf69599664b0341be35317e18b8b5;hp=a608363b2d606eb927343437b0fae948a6fedb04;hpb=49fe0eec8f17698fc5f86d0abe01777af1fb2b23;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index a608363b..2637f7f8 100644 --- a/README.md +++ b/README.md @@ -2,66 +2,15 @@ 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 - -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 : +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 -``` +This will build both projects under build directory for each of them with default configuration.