X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=1629ffbcd1a34c45ec737aa0cebd9f901706f907;hb=64f08bebe63e2b58102044ac02deac53bbec2d5f;hp=55fc453e1d90aa16d7db930a76c331a800d2be9b;hpb=db3dea9a59746b26b966b022d046ec8e44c37539;p=apps%2Flow-level-can-service.git diff --git a/README.md b/README.md index 55fc453..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: @@ -50,4 +64,4 @@ gendocs.sh doxygen or ```bash cd build && make doxygen -``` \ No newline at end of file +```