X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=d57a3187d7d60ef73e56e07646a746a9b25b2e01;hb=0e037a2f0fac7801feaa6187b9c9bf785ffaf85f;hp=35bccdff6694d3c0575bd1cbfc2118e38e603429;hpb=a3cbfc8490394437006dd8bedabfd336cf06fc74;p=apps%2Fagl-service-can-low-level.git diff --git a/README.md b/README.md index 35bccdff..d57a3187 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -#CAN Configuration Generator +# CAN Configuration Generator -##Abstract +## Abstract -This tool is used to generate a configuration source file for the Low Level CAN bus binding. -This binding need a configuration provided as a C++ source file. +This tool is used to generate a configuration source file for the [Low Level CAN bus binding](https://github.com/iotbzh/CAN_signaling). +This binding needs a configuration provided as a C++ source file. As long this binding is based on [OpenXC vi-firmware](https://github.com/openxc/vi-firmware), this generator use the JSON format from the [python generator](https://github.com/openxc/openxc-python). The reference documentation of the JSON file can be found [here](https://github.com/openxc/vi-firmware/blob/master/docs/config/reference.rst). @@ -99,4 +99,4 @@ This generator will follow OpenXC support status of the low level CAN signaling Copyright 2017 - iotbzh -Licensed under the [Apache License 2.0](https://github.com/iotbzh/can-config-generator/blob/master/LICENSE) \ No newline at end of file +Licensed under the [Apache License 2.0](https://github.com/iotbzh/can-config-generator/blob/master/LICENSE)