Skip to content

Commit d01e762

Browse files
authored
Update README.md
Fix typo and reword some bits, and add note that new RPiOS images have requirements pre-installed
1 parent 553b87d commit d01e762

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ All requirements for macOS can be installed by running `xcode-select --install`
2929
- Native C/C++ compiler (in PATH), supported compilers are: `gcc` and `clang`
3030

3131
### Raspberry Pi OS
32-
All requirements for Raspberry Pi OS can be installed by running `sudo apt install openocd ninja-build`
32+
As of March 2024, all new Raspberry Pi OS images come with the requirements pre-installed.
33+
On older images the requirements can be installed by running `sudo apt install openocd ninja-build`
3334

3435
### Linux
3536
- Python 3.9 or later (in PATH or set in settings)
@@ -48,11 +49,11 @@ This extension contributes the following settings:
4849
* `raspberry-pi-pico.ninjaPath`: Set custom ninja path
4950
* `raspberry-pi-pico.gitPath`: Set custom git path
5051
* `raspberry-pi-pico.cmakeAutoConfigure`: Enable/Disable cmake auto configure on project load
51-
* `raspberry-pi-pico.githubToken`: Takes a GitHub personal access token (classic) with the `public_repo` scope. It is used to check GitHub for available versions of the Pico SDK and other tools. Without one, the extension will use the GitHub API unauthenticated, which has a much lower rate limit causing many features to not work properly if the limit is reached.
52+
* `raspberry-pi-pico.githubToken`: Takes a GitHub personal access token (classic) with the `public_repo` scope. It is used to check GitHub for available versions of the Pico SDK and other tools. Without one, the extension will use the GitHub API unauthenticated, which has a much lower rate limit causing many features to not work properly if the limit is reached. The unauthenticated rate limit is per public IP address, so this is more likely to be necessary if you share your IP address with many other users.
5253

5354
## Known Issues
5455

55-
- Custom Ninja, Python3 or git paths are not stored in `CMakeLists.txt` like SDK and Toolchain paths so using them would require to build and configure the project thought the extension
56+
- Custom Ninja, Python3 and git paths are not stored in `CMakeLists.txt` like the SDK and Toolchain paths, so using them requires the user to build and configure the project through the extension
5657

5758
### GitHub API Rate Limit ("Error while retrieving SDK and toolchain versions")
5859

0 commit comments

Comments
 (0)