X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=4d9892f879d55b60333f14debb1117b91a84ca38;hb=refs%2Fchanges%2F21%2F15821%2F1;hp=55fc453e1d90aa16d7db930a76c331a800d2be9b;hpb=db3dea9a59746b26b966b022d046ec8e44c37539;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index 55fc453e..4d9892f8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ -# 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. Full document can be found under `docs` directory. +# Fast build procedure + +Just use autobuild script: + +```bash +./conf.d/autobuild/agl/autobuild build +./conf.d/autobuild/agl/autobuild package +``` + +This will build both projects under build directory for each of them with default configuration. + # Generate documentation ## Prerequisites @@ -18,7 +29,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 +61,4 @@ gendocs.sh doxygen or ```bash cd build && make doxygen -``` \ No newline at end of file +```