Skip to content

Commit

Permalink
Fix settings descriptions
Browse files Browse the repository at this point in the history
Fixes #143
  • Loading branch information
will-v-pi authored Jan 6, 2025
1 parent 3e26da6 commit 2b7efa4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ This extension provides the following settings:
* `raspberry-pi-pico.python3Path`: Specify a custom path for Python 3 _(machine scoped)_.
* `raspberry-pi-pico.ninjaPath`: Specify a custom path for Ninja.
* `raspberry-pi-pico.gitPath`: Specify a custom path for Git.
* `raspberry-pi-pico.cmakeAutoConfigure`: Provide a GitHub personal access token (classic) with the `public_repo` scope. This token is used to check for available versions of the Pico SDK and other tools. Without it, the extension uses the unauthenticated GitHub API, which has a lower rate limit and may lead to restricted functionality if the limit is exceeded. The unauthenticated rate limit is per public IP address, so a token is more necessary if your IP is shared with many users.
* `raspberry-pi-pico.cmakeAutoConfigure`: Enable/Disable automatic CMake configuration when project is opened
* `raspberry-pi-pico.useCmakeTools`: Enable/Disable the CMake Tools Extension Integration (see below)
* `raspberry-pi-pico.githubToken`: Provide a GitHub personal access token (classic) with the `public_repo` scope. This token is used to check for available versions of the Pico SDK and other tools. Without it, the extension uses the unauthenticated GitHub API, which has a lower rate limit and may lead to restricted functionality if the limit is exceeded. The unauthenticated rate limit is per public IP address, so a token is more necessary if your IP is shared with many users.

## CMake Tools Extension Integration

Expand Down

0 comments on commit 2b7efa4

Please sign in to comment.