X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=2637f7f811213476bfa978a54188f0a0a2473231;hb=390745b93c5f4af9b148c94433f44ec462a39770;hp=4d9892f879d55b60333f14debb1117b91a84ca38;hpb=3e6d3fa8be349b40d6fd03d198b5e033cc7719e2;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index 4d9892f8..2637f7f8 100644 --- a/README.md +++ b/README.md @@ -14,51 +14,3 @@ Just use autobuild script: ``` This will build both projects under build directory for each of them with default configuration. - -# 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 install doxygen graphviz -``` - -Prepare your build environment: - -```bash -mkdir build && cd build -cmake .. -``` - -## 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 -```