From c3f7014ef508f5192490ed65344cafa631b73f5b Mon Sep 17 00:00:00 2001 From: Leonardo Cavagnis Date: Tue, 29 Jul 2025 12:53:17 +0200 Subject: [PATCH 1/4] update readme.md: add pre-requirements for macOS --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cfbcde69..0a0e1cff 100644 --- a/README.md +++ b/README.md @@ -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 From 208d337ed30607db8298bebaa9c30224767deb27 Mon Sep 17 00:00:00 2001 From: Leonardo Cavagnis Date: Tue, 29 Jul 2025 16:02:02 +0200 Subject: [PATCH 2/4] update README: fix flash loader instruction --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0a0e1cff..89f80c78 100644 --- a/README.md +++ b/README.md @@ -180,10 +180,28 @@ 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 -d build/ +``` + +The `` appears in the build output when you run the build script. For example: + ```bash -west flash +% ./extra/build.sh portentah7 + +Build target: arduino_portenta_h7@1.0.0//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 From aa59658f70c14e9917a7366074451dd70a152df7 Mon Sep 17 00:00:00 2001 From: Leonardo Cavagnis Date: Tue, 29 Jul 2025 16:19:48 +0200 Subject: [PATCH 3/4] update readme: IDE usage --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 89f80c78..decf0417 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,9 @@ This can also be performed via the "Burn bootloader" action in the IDE if the co 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] From f1c6d8a1a9b7c8f75ee24ab2c6bdaabdd8efceb7 Mon Sep 17 00:00:00 2001 From: Leonardo Cavagnis <45899760+leonardocavagnis@users.noreply.github.com> Date: Tue, 29 Jul 2025 17:25:14 +0200 Subject: [PATCH 4/4] Update README.md Co-authored-by: Luca Burelli --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index decf0417..d9dafc94 100644 --- a/README.md +++ b/README.md @@ -208,7 +208,7 @@ This can also be performed via the "Burn bootloader" action in the IDE if the co 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 +Remember to also install and/or update the officially published core in the IDE Board Manager to get the latest tools and dependencies. [⚙️ Installation](#️-installation). ## 🚀 Adding a new target