README.md

   1 # CAN signaling binder
   2
   3 CAN bus binder, based upon OpenXC vi-firmware project.
   4
   5 Full document can be found under `docs` directory.
   6
   7 # Fast build procedure
   8
   9 Just use autobuild script:
  10
  11 ```bash
  12 ./conf.d/autobuild/agl/autobuild build
  13 ./conf.d/autobuild/agl/autobuild package
  14 ```
  15
  16 This will build both projects under build directory for each of them with default configuration.
  17
  18 # Generate documentation
  19
  20 ## Prerequisites
  21
  22 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:
  23
  24 ```bash
  25 sudo npm install -g gitbook-cli
  26 sudo apt-get install calibre
  27 ```
  28
  29 To generate Doxygen documentation, you'll need doxygen and graphviz:
  30
  31 ```bash
  32 sudo apt-get install doxygen graphviz
  33 ```
  34
  35 Prepare your build environment:
  36
  37 ```bash
  38 mkdir build && cd build
  39 cmake ..
  40 ```
  41
  42 ## Generation
  43
  44 Generate a PDF version :
  45
  46 ```bash
  47 gendocs.sh pdf
  48 ```
  49
  50 Serve an HTML version, this will run a web server that will serve you locally documentation :
  51
  52 ```bash
  53 gendocs.sh serve
  54 ```
  55
  56 Generate doxygen documentation:
  57
  58 ```bash
  59 gendocs.sh doxygen
  60 ```
  61 or
  62 ```bash
  63 cd build && make doxygen
  64 ```