Skip to content

Commit 5fd8fa8

Browse files
authored
Update README.md
1 parent 96bd009 commit 5fd8fa8

File tree

1 file changed

+87
-2
lines changed

1 file changed

+87
-2
lines changed

CI/build/README.md

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Will ignore `04.Communication/MultiSerial.ino` and `04.Communication/SerialPasst
131131
}
132132
```
133133

134-
Will build all sketch available in `09.USB/*` for the listed boards and add `usb=HID` option to the fqbn
134+
Will build all sketches available in `09.USB/*` for the listed boards and add `usb=HID` option to the fqbn
135135
```json
136136
{
137137
"pattern": "09.USB",
@@ -143,5 +143,90 @@ Will build all sketch available in `09.USB/*` for the listed boards and add `us
143143

144144
## Usage examples
145145

146-
ToDo
146+
* List all boards containing `F1` or `L4` (not case sensitive):
147147

148+
`python3 arduino-builder.py -l -b "F1|l4"`
149+
150+
Will produce on the [stm32](https://github.com/stm32duino/Arduino_Core_STM32) core:
151+
```
152+
Cores configuration JSON file that will be used: conf/cores_config.json
153+
Build configuration for 'STM32' maintainer and 'stm32' architecture
154+
9 board(s) available
155+
BLUEPILL_F103C8
156+
DISCO_F100RB
157+
DISCO_L475VG_IOT
158+
MAPLEMINI_F103CB
159+
NUCLEO_F103RB
160+
NUCLEO_L432KC
161+
NUCLEO_L476RG
162+
NUCLEO_L496ZG
163+
NUCLEO_L496ZG-P
164+
```
165+
166+
* List all sketch containing `digital` or `analog` (not case sensitive):
167+
168+
`python3 arduino-builder.py -l sketch -s "Digital|analog"`
169+
170+
Will produce on the [stm32](https://github.com/stm32duino/Arduino_Core_STM32) core:
171+
```
172+
Cores configuration JSON file that will be used: conf/cores_config.json
173+
Build configuration for 'STM32' maintainer and 'stm32' architecture
174+
<Arduino path>/examples/01.Basics/AnalogReadSerial/AnalogReadSerial.ino
175+
<Arduino path>/examples/01.Basics/DigitalReadSerial/DigitalReadSerial.ino
176+
<Arduino path>/examples/01.Basics/ReadAnalogVoltage/ReadAnalogVoltage.ino
177+
<Arduino path>/examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino
178+
<Arduino path>/examples/02.Digital/Button/Button.ino
179+
<Arduino path>/examples/02.Digital/Debounce/Debounce.ino
180+
<Arduino path>/examples/02.Digital/DigitalInputPullup/DigitalInputPullup.ino
181+
<Arduino path>/examples/02.Digital/StateChangeDetection/StateChangeDetection.ino
182+
<Arduino path>/examples/02.Digital/toneKeyboard/toneKeyboard.ino
183+
<Arduino path>/examples/02.Digital/toneMelody/toneMelody.ino
184+
<Arduino path>/examples/02.Digital/toneMultiple/toneMultiple.ino
185+
<Arduino path>/examples/02.Digital/tonePitchFollower/tonePitchFollower.ino
186+
<Arduino path>/examples/03.Analog/AnalogInOutSerial/AnalogInOutSerial.ino
187+
<Arduino path>/examples/03.Analog/AnalogInput/AnalogInput.ino
188+
<Arduino path>/examples/03.Analog/AnalogWriteMega/AnalogWriteMega.ino
189+
<Arduino path>/examples/03.Analog/Calibration/Calibration.ino
190+
<Arduino path>/examples/03.Analog/Fading/Fading.ino
191+
<Arduino path>/examples/03.Analog/Smoothing/Smoothing.ino
192+
<Arduino path>/examples/10.StarterKit_BasicKit/p08_DigitalHourglass/p08_DigitalHourglass.ino
193+
19 sketches found
194+
```
195+
196+
* Build all sketches containing `digital` or `analog` for all boards containing `F1` or `L4` (not case sensitive):
197+
198+
`python3 arduino-builder.py -s "Digital|analog"`
199+
200+
* List all boards for STM32F1 core:
201+
202+
`python3 arduino-builder.py -l --arch STM32F1`
203+
204+
Will list:
205+
```
206+
Cores configuration JSON file that will be used: conf/cores_config.json
207+
Build configuration for 'Arduino_STM32' maintainer and 'STM32F1' architecture
208+
23 board(s) available
209+
NucleoF103_HSE
210+
NucleoF103_HSI
211+
STM32F103C8
212+
STM32F103CB
213+
STM32F103R8
214+
STM32F103RB
215+
STM32F103RC
216+
STM32F103RE
217+
STM32F103T8
218+
STM32F103TB
219+
STM32F103VB
220+
STM32F103VC
221+
STM32F103VD
222+
STM32F103VE
223+
STM32F103ZC
224+
STM32F103ZD
225+
STM32F103ZE
226+
STM32VLD
227+
hytiny-stm32f103t
228+
maple
229+
mapleMini
230+
mapleRET6
231+
microduino32_flash
232+
```

0 commit comments

Comments
 (0)