explain why buses node is not supported.

[apps/agl-service-can-low-level.git] / README.md

diff --git a/README.md b/README.md
index 35bccdf..288bcc5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-#CAN Configuration Generator\r
+# CAN Configuration Generator\r
 \r
-##Abstract\r
+## Abstract\r
 \r
-This tool is used to generate a configuration source file for the Low Level CAN bus binding.\r
-This binding need a configuration provided as a C++ source file.\r
+This tool is used to generate a configuration source file for the [Low Level CAN bus binding](https://github.com/iotbzh/CAN_signaling).\r
+This binding needs a configuration provided as a C++ source file.\r
 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).\r
 The reference documentation of the JSON file can be found [here](https://github.com/openxc/vi-firmware/blob/master/docs/config/reference.rst).\r
 \r
@@ -84,9 +84,11 @@ Use the `-h` option to display help.
 ## Supported OpenXC items\r
 \r
 As long as the low level CAN signaling binding doesn't fully support OpenXC yet, this generator is also limited.\r
-For instance, `initializers`, `loopers`, `buses`, `commands` and `handlers` nodes are ignored for now.\r
+For instance, `initializers`, `loopers`, `commands` and `handlers` nodes are ignored for now.\r
 This generator will follow OpenXC support status of the low level CAN signaling binding.\r
 \r
+The `buses` item will not be supported by this generator because the binding use another way to declare and configure buses. Please refer to the binding's documentation.\r
+\r
 ## Known issues\r
 \r
 * Each `diagnostic_message` must define the same `bus` as the binding will use only one bus.\r
@@ -99,4 +101,4 @@ This generator will follow OpenXC support status of the low level CAN signaling
 \r
 Copyright 2017 - iotbzh\r
 \r
-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)\r