Skip to content

Commit 96bd009

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

File tree

1 file changed

+84
-1
lines changed

1 file changed

+84
-1
lines changed

CI/build/README.md

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,90 @@ Sketch(es) options:
5656

5757
## Cores configuration files
5858

59-
ToDo
59+
Script is able to uses a JSON configuration file containing the build configuration for one or more maintainer/architecture.
60+
A default configuration file is provided: [cores_config.json](conf/cores_config.json)
61+
62+
63+
#### Template
64+
```json
65+
{
66+
"cores": [
67+
{
68+
"maintainer": "maintainer/vendor name",
69+
"architecture": "architecture name",
70+
"boards": [
71+
{
72+
"name": "board1",
73+
"options": "specific options for board1 to concatenate with the fqbn"
74+
},
75+
{
76+
"name": "board2",
77+
"fqbn": "Fully Qualified Board Name and options, used instead of generated one"
78+
}
79+
],
80+
"sketches": [
81+
{
82+
"pattern": "sketche(s) pattern",
83+
"applicable": true,
84+
"boards": [ "List of boards (comma separated) which can be built for the sketche(s) pattern. Only those listed board will be built." ],
85+
"options": "specific options to build the matched sketch pattern to concatenate with the fqbn (optional)"
86+
},
87+
{
88+
"pattern": "sketche(s) pattern",
89+
"applicable": false,
90+
"boards": [ "List of boards (comma separated) which cannot be built for the sketche(s) pattern. All others available boards will be built." ]
91+
}
92+
]
93+
},
94+
{
95+
"maintainer": "Other maintainer/vendor name",
96+
"architecture": "Other architecture name",
97+
"boards": [
98+
{
99+
"name": "boardx",
100+
"options": "specific options for board1 to concatenate with the fqbn"
101+
}
102+
],
103+
"sketches": [
104+
{
105+
"pattern": "sketchbook",
106+
"applicable": true,
107+
"boards": [ "" ]
108+
}
109+
]
110+
}
111+
]
112+
}
113+
```
114+
115+
#### Template
116+
117+
Will add `flash=C8` option to the fqbn of the BLUEPILL_F103C8 board
118+
```json
119+
{
120+
"name": "BLUEPILL_F103C8",
121+
"options": "flash=C8"
122+
}
123+
```
124+
125+
Will ignore `04.Communication/MultiSerial.ino` and `04.Communication/SerialPassthrough.ino`
126+
```json
127+
{
128+
"pattern": "04.Communication/(Multi)?Serial(Passthrough)?",
129+
"applicable": true,
130+
"boards": [ "" ]
131+
}
132+
```
133+
134+
Will build all sketch available in `09.USB/*` for the listed boards and add `usb=HID` option to the fqbn
135+
```json
136+
{
137+
"pattern": "09.USB",
138+
"applicable": true,
139+
"boards": [ "NUCLEO_F429ZI", "DISCO_L475VG_IOT", "DISCO_F407VG" ],
140+
"options": "usb=HID"
141+
}
142+
```
60143

61144
## Usage examples
62145

0 commit comments

Comments
 (0)