README.md

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