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
## Getting started\r
+\r
### Build requirements\r
\r
* CMake version 3.0 or later\r
\r
You can install any of these using your package manager. For instance, inside the iotbzh's docker image, you must enter this command :\r
\r
- devel@bsp-devkit:~/$ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev\r
+ sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-program-options-dev\r
\r
You may want to install `libboost-all-dev` to get all boost components even if it's not required.\r
\r
$ cd build\r
$ cmake -G "Unix Makefiles" ..\r
$ make\r
-</pre>\r
+```\r
\r
### Naming convention\r
\r
engine.torque\r
```\r
\r
-> **NOTE** It's recommended that you follow this naming convention to named your CAN signals.\r
+> **NOTE** It's recommended that you follow this naming convention to name your CAN signals.\r
>\r
> There is only character `*` that is forbidden in names because it's used as wildcard for subscription and unsubscrition.\r
>\r
## Generate your config file\r
\r
To generate your config file you just have to run the generator using the `-m` option to specify your JSON file.\r
-<pre>\r
-<b>devel@bsp-devkit:~/projects/can-config-generator/build(master)$</b> can-config-generator -m ../tests/basic.json -o configuration-generated.cpp\r
-</pre>\r
+\r
+```bash\r
+./can-config-generator -m ../tests/basic.json -o configuration-generated.cpp\r
+```\r
\r
If you omit the `-o` option, then code is generated on the stdout.\r
You also can specify a header and a footer file.\r