diff --git a/src/genpinmap/README.md b/src/genpinmap/README.md new file mode 100644 index 00000000..1ded9a0a --- /dev/null +++ b/src/genpinmap/README.md @@ -0,0 +1,16 @@ +# genpinmap + +This script is able to generate the `PeripheralPins.c` for a specific board. + +After file generation, review it carefully and please report any issue +[here](https://github.com/stm32duino/Arduino_Tools/issues) + +Once generated, you should comment a line if the pin is generated
+several times for the same IP or if the pin should not be used
+(overlaid with some HW on the board, for instance) + +Usage: `python genpinmap_arduino.py ` + - `` is the name of the directory where `PeripheralPins.c` will be generated under _./Arduino_ directory + - `` is the STM32 file description in [STM32CubeMX](http://www.st.com/en/development-tools/stm32cubemx.html) + +**!! This xml file contains non alpha characters in its name, you should call it with quotes**