1 # Low level CAN signaling binder
3 Low level CAN bus binder, based upon OpenXC vi-firmware project.
5 Full document can be found under `docs` directory.
7 # Generate documentation
11 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:
14 sudo npm install -g gitbook-cli
15 sudo apt-get install calibre
18 To generate Doxygen documentation, you'll need doxygen and graphviz:
21 sudo apt-get install doxygen graphviz
24 Prepare your build environment:
27 mkdir build && cd build
33 Generate a PDF version :
39 Serve an HTML version, this will run a web server that will serve you locally documentation :
45 Generate doxygen documentation:
52 cd build && make doxygen