aboutsummaryrefslogtreecommitdiffstats

CAN signaling binder

CAN bus binder, based upon OpenXC vi-firmware project.

Full document can be found under docs directory.

Fast build procedure

Just use autobuild script:

./conf.d/autobuild/agl/autobuild build
./conf.d/autobuild/agl/autobuild package

This will build both projects under build directory for each of them with default configuration.

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:

sudo npm install -g gitbook-cli
sudo apt-get install calibre

To generate Doxygen documentation, you'll need doxygen and graphviz:

sudo apt-get install doxygen graphviz

Prepare your build environment:

mkdir build && cd build
cmake ..

Generation

Generate a PDF version :

gendocs.sh pdf

Serve an HTML version, this will run a web server that will serve you locally documentation :

gendocs.sh serve

Generate doxygen documentation:

gendocs.sh doxygen

or

cd build && make doxygen