Skip to content

Commit e30c16f

Browse files
Merge pull request #156 from leonardocavagnis/macos_setup_readme
Update README.md: pre-requirements for macOS and fix flash loader instructions
2 parents f341755 + f1c6d8a commit e30c16f

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,21 @@ git clone https://github.com/arduino/ArduinoCore-zephyr
125125
### Pre-requirements
126126
Before running the installation script, ensure that Python, `pip` and `venv` are installed on your system. The script will automatically install `west` and manage the necessary dependencies.
127127

128-
On Ubuntu or similar `apt`-based distros, make sure to run the following command:
128+
#### On Ubuntu or similar apt-based distros
129129
```bash
130130
sudo apt install python3-pip python3-setuptools python3-venv build-essential git cmake ninja-build zstd jq
131131
```
132+
#### On macOS
133+
Make sure you have Homebrew installed. Then run:
134+
135+
```bash
136+
# Install Xcode Command Line Tools (needed for compilers and make)
137+
xcode-select --install
138+
139+
# Install required tools and libraries
140+
brew install python cmake ninja zstd jq git
141+
```
142+
Note: Homebrew’s Python installation already includes `pip`, `setuptools` and `venv`.
132143

133144
### Run the ```bootstrap``` script
134145
```bash
@@ -169,16 +180,37 @@ associated variant will be updated.
169180

170181
### Flash the Loader
171182

172-
If the board is fully supported by Zephyr, you can flash the firmware directly onto the board using the following command:
183+
To flash the loader, run:
184+
173185
```bash
174-
west flash
186+
west flash -d build/<variant-name>
175187
```
188+
189+
The `<variant-name>` appears in the build output when you run the build script. For example:
190+
191+
```bash
192+
% ./extra/build.sh portentah7
193+
194+
Build target: [email protected]//m7
195+
Build variant: arduino_portenta_h7_stm32h747xx_m7
196+
-- west build: generating a build system
197+
...
198+
```
199+
200+
In this case, you would flash with:
201+
```bash
202+
west flash -d build/arduino_portenta_h7_stm32h747xx_m7
203+
```
204+
176205
This can also be performed via the "Burn bootloader" action in the IDE if the core is properly installed, as detailed below.
177206

178207
### Using the Core in Arduino IDE/CLI
179208

180209
After running the `bootstrap.sh` script, you can symlink the core to `$sketchbook/hardware/arduino-git/zephyr`. Once linked, it will appear in the IDE/CLI, and the board's Fully Qualified Board Name (FQBN) will be formatted as `arduino-git:zephyr:name_from_boards_txt`.
181210

211+
Remember to also install and/or update the officially published core in the IDE Board Manager to get the latest tools and dependencies.
212+
[⚙️ Installation](#️-installation).
213+
182214
## 🚀 Adding a new target
183215

184216
> [!TIP]

0 commit comments

Comments
 (0)