Skip to content

Update README.md: pre-requirements for macOS and fix flash loader instructions #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 30, 2025
Merged

Update README.md: pre-requirements for macOS and fix flash loader instructions #156

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c3f7014
update readme.md: add pre-requirements for macOS
leonardocavagnis Jul 29, 2025
208d337
update README: fix flash loader instruction
leonardocavagnis Jul 29, 2025
aa59658
update readme: IDE usage
leonardocavagnis Jul 29, 2025
f1c6d8a
Update README.md
leonardocavagnis Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,21 @@ git clone https://github.com/arduino/ArduinoCore-zephyr
### Pre-requirements
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.

On Ubuntu or similar `apt`-based distros, make sure to run the following command:
#### On Ubuntu or similar apt-based distros
```bash
sudo apt install python3-pip python3-setuptools python3-venv build-essential git cmake ninja-build zstd jq
```
#### On macOS
Make sure you have Homebrew installed. Then run:

```bash
# Install Xcode Command Line Tools (needed for compilers and make)
xcode-select --install

# Install required tools and libraries
brew install python cmake ninja zstd jq git
```
Note: Homebrew’s Python installation already includes `pip`, `setuptools` and `venv`.

### Run the ```bootstrap``` script
```bash
Expand Down Expand Up @@ -169,16 +180,37 @@ associated variant will be updated.

### Flash the Loader

If the board is fully supported by Zephyr, you can flash the firmware directly onto the board using the following command:
To flash the loader, run:

```bash
west flash
west flash -d build/<variant-name>
```

The `<variant-name>` appears in the build output when you run the build script. For example:

```bash
% ./extra/build.sh portentah7

Build target: [email protected]//m7
Build variant: arduino_portenta_h7_stm32h747xx_m7
-- west build: generating a build system
...
```

In this case, you would flash with:
```bash
west flash -d build/arduino_portenta_h7_stm32h747xx_m7
```

This can also be performed via the "Burn bootloader" action in the IDE if the core is properly installed, as detailed below.

### Using the Core in Arduino IDE/CLI

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`.

Remember to also update the core from the Board Manager in the IDE to get the latest tools and dependencies. See section
[⚙️ Installation](#️-installation).

## 🚀 Adding a new target

> [!TIP]
Expand Down