README.md

   1 # Low level CAN signaling binder
   2
   3 Low level CAN bus binder, based upon OpenXC vi-firmware project.
   4
   5 Full document can be found under `docs` directory.
   6
   7 # Generate documentation
   8
   9 ## Prerequisites
  10
  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:
  12
  13 ```bash
  14 sudo npm install -g gitbook-cli
  15 sudo apt-get install calibre
  16 ```
  17
  18 To generate Doxygen documentation, you'll need doxygen and graphviz:
  19
  20 ```bash
  21 sudo apt-get doxygen graphviz
  22 ```
  23
  24 Prepare your build environment:
  25
  26 ```bash
  27 mkdir build && cd build
  28 cmake ..
  29 ```
  30
  31 ## Generation
  32
  33 Generate a PDF version :
  34
  35 ```bash
  36 make pdf
  37 ```
  38
  39 Serve an HTML version, this will run a web server that will serve you locally documentation :
  40
  41 ```bash
  42 make serve
  43 ```
  44
  45 Generate doxygen documentation:
  46
  47 ```bash
  48 make doxygen
  49 ```