X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=55fc453e1d90aa16d7db930a76c331a800d2be9b;hb=2fb9740452b75e25a277164947f345f120a4bfe7;hp=f346327267ee41fc3a197b0b13c6115bd71faead;hpb=16db388d019dba0dcae16004c5529d5ee0760b3a;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index f3463272..55fc453e 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,51 @@ Low level CAN bus binder, based upon OpenXC vi-firmware project. Full document can be found under `docs` directory. -Note that your can use gitbook to serve documentation: + +# 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: + +```bash +sudo npm install -g gitbook-cli +sudo apt-get install calibre +``` + +To generate Doxygen documentation, you'll need doxygen and graphviz: + +```bash +sudo apt-get doxygen graphviz ``` + +Prepare your build environment: + +```bash mkdir build && cd build cmake .. -make serve-docs +``` + +## Generation + +Generate a PDF version : + +```bash +gendocs.sh pdf +``` + +Serve an HTML version, this will run a web server that will serve you locally documentation : + +```bash +gendocs.sh serve +``` + +Generate doxygen documentation: + +```bash +gendocs.sh doxygen +``` +or +```bash +cd build && make doxygen ``` \ No newline at end of file