Skip to content

Commit 0042fa2

Browse files
authored
Create README.md
1 parent 7b9b4db commit 0042fa2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/genpinmap/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# genpinmap
2+
3+
This script is able to generate the `PeripheralPins.c` for a specific board.
4+
5+
After file generation, review it carefully and please report any issue
6+
[here](https://github.com/stm32duino/Arduino_Tools/issues)
7+
8+
Once generated, you should comment a line if the pin is generated<br>
9+
several times for the same IP or if the pin should not be used<br>
10+
(overlaid with some HW on the board, for instance)
11+
12+
Usage: `python genpinmap_arduino.py <Name> <product xml file name>`
13+
- `<Name>` is the name of the directory where `PeripheralPins.c` will be generated under _./Arduino_ directory
14+
- `<product xml file name>` is the STM32 file description in [STM32CubeMX](http://www.st.com/en/development-tools/stm32cubemx.html)
15+
16+
**!! This xml file contains non alpha characters in its name, you should call it with quotes**

0 commit comments

Comments
 (0)