Skip to content

Commit c43e487

Browse files
committed
README: update migration instructions for release 0.3.2
1 parent f11ef1c commit c43e487

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,11 @@ The most important components of this project are:
114114
## 🛠️ Setup a Zephyr build environment
115115

116116
> [!WARNING]
117-
> If you checked out this repo before 0.3.2 was released, delete your local copy and clone the repository again following the installation instructions. See [#163](https://github.com/arduino/ArduinoCore-zephyr/issues/163) for more details.
117+
> If you checked out this repo before 0.3.2 was released, please note that
118+
> development has switched to the `main` branch; the old `arduino` branch will
119+
> be removed in the short future. Please follow this
120+
> [migration guide](https://github.com/arduino/ArduinoCore-zephyr/issues/163)
121+
> to update your local branches and outstanding PRs.
118122
119123
In this section, we’ll guide you through setting up your environment to work on and update the Zephyr core.
120124

@@ -145,17 +149,17 @@ brew install python cmake ninja zstd jq git
145149
Note: Homebrew’s Python installation already includes `pip`, `setuptools` and `venv`.
146150

147151
### On Windows
148-
Building natively on Windows is not currently supported; however, it is possible to setup and build the loader using [WSL](https://learn.microsoft.com/windows/wsl/about). You will need to follow the instructions given above for installing on Ubuntu.
152+
Building natively on Windows is not currently supported; however, it is possible to setup and build the loader using [WSL](https://learn.microsoft.com/windows/wsl/about). Once you have that installed, you will need to follow these instructions as if you had Ubuntu.
149153

150-
There are two strategies:
154+
There are two strategies to set up the sources for building the loader on Windows:
151155
1) Install the sources in the native Windows filesystem (NTFS, FAT32, etc) and within WSL, cd to the root directory where you installed your sources, like: `/mnt/d/github/ArduinoCore-zephyr`.
152156
2) Install the sources within the WSL file system, like: `~/git/ArduinoCore-zephyr`
153157

154158
There are pros and cons to both strategies:
155-
1) Builds are relatively very slow, but once done you can use it directly within Arduino.
156-
2) Builds are a lot faster, however, you need to copy the resulting build back to somewhere in your windows directory structure. It is this location, that you will add to the Arduino IDE as mentioned below in the section: Using the core in Arduino IDE/CLI.
159+
1) Builds on the native Windows file system are relatively very slow, but once done, you can use the results directly within the Arduino IDE.
160+
2) Builds on WSL's file system are a lot faster, however, you need to copy the resulting build back to somewhere in your Windows directory structure. Use this location in the Arduino IDE as mentioned below in the [Using the Core in Arduino IDE/CLI](#using-the-core-in-arduino-idecli) section.
157161

158-
In either strategy, you may have to update the link: `cores\arduino\api`.
162+
After `bootstrap.sh` has completed, you may also have to update the `cores\arduino\api` link to the path of the ArduinoCore-API's `api` folder.
159163

160164
### Run the ```bootstrap``` script
161165
```bash

0 commit comments

Comments
 (0)