X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=1629ffbcd1a34c45ec737aa0cebd9f901706f907;hb=6ed34a503ac6a32be4a06721b9797e7d94ba8e22;hp=bcf998191629f9d6919d4a7e4328a15d96ead72d;hpb=d32b0760ee2184ee6281e40d134aacbc5d395f77;p=apps%2Flow-level-can-service.git diff --git a/README.md b/README.md index bcf9981..1629ffb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ -# Low level CAN signaling binder +# CAN signaling binder -Low level CAN bus binder, based upon OpenXC vi-firmware project. +CAN bus binder, based upon OpenXC vi-firmware project. + +There are 2 separated projects here, one with the CAN-binder that is installed +on an AGL target and the CAN config generator used to generate a source file for +the low level binding. Full document can be found under `docs` directory. +# Fast build procedure + +Just use build.sh script: + +```bash +./build.sh +``` + +This will build both projects under build directory for each of them with default configuration. + # Generate documentation ## Prerequisites @@ -18,7 +32,7 @@ sudo apt-get install calibre To generate Doxygen documentation, you'll need doxygen and graphviz: ```bash -sudo apt-get doxygen graphviz +sudo apt-get install doxygen graphviz ``` Prepare your build environment: @@ -33,17 +47,21 @@ cmake .. Generate a PDF version : ```bash -make pdf +gendocs.sh pdf ``` Serve an HTML version, this will run a web server that will serve you locally documentation : ```bash -make serve +gendocs.sh serve ``` Generate doxygen documentation: ```bash -make doxygen -``` \ No newline at end of file +gendocs.sh doxygen +``` +or +```bash +cd build && make doxygen +```