Skip to content

Commit

Permalink
Add note on VS Code profiles to readme, and add sample profile (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
will-v-pi committed Aug 25, 2024
1 parent d892427 commit 45507c7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ This extension contributes the following settings:
* `raspberry-pi-pico.cmakeAutoConfigure`: Enable/Disable cmake auto configure on project load
* `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.

## VS Code Profiles

For developers working with multiple microcontroller toolchains, you can install the extension into a [VS Code Profile](https://code.visualstudio.com/docs/editor/profiles) to prevent conflicts with other toolchains. To do this simply download the sample profile [here](scripts/Pico.code-profile), then press Ctrl+Shift+P and click "Profiles: Import Profile" to import that file. This will install the extension into only the Pico profile, to prevent any conflicts with other extensions.

## Known Issues

- 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
Expand Down
1 change: 1 addition & 0 deletions scripts/Pico.code-profile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"name":"Pico","extensions":"[{\"identifier\":{\"id\":\"marus25.cortex-debug\",\"uuid\":\"2fd8abff-b3ce-46c9-a6a8-92d5ad69d8d0\"},\"displayName\":\"Cortex-Debug\"},{\"identifier\":{\"id\":\"mcu-debug.debug-tracker-vscode\",\"uuid\":\"bd8507f9-4b21-4877-b045-1f20471fe96e\"},\"displayName\":\"debug-tracker-vscode\"},{\"identifier\":{\"id\":\"mcu-debug.memory-view\",\"uuid\":\"f319e29a-19e8-43fb-8e3e-e264b6144083\"},\"displayName\":\"MemoryView\"},{\"identifier\":{\"id\":\"mcu-debug.peripheral-viewer\",\"uuid\":\"e6f326b2-3602-4e64-9cd1-ebe454be1992\"},\"displayName\":\"Peripheral Viewer\"},{\"identifier\":{\"id\":\"mcu-debug.rtos-views\",\"uuid\":\"0b85f1d6-1d95-4f57-bacd-ca639159f71d\"},\"displayName\":\"RTOS Views\"},{\"identifier\":{\"id\":\"ms-vscode.cmake-tools\",\"uuid\":\"7c889349-8749-43d4-8b5e-08939936d7f4\"},\"displayName\":\"CMake Tools\"},{\"identifier\":{\"id\":\"ms-vscode.cpptools\",\"uuid\":\"690b692e-e8a9-493f-b802-8089d50ac1b2\"},\"displayName\":\"C/C++\"},{\"identifier\":{\"id\":\"ms-vscode.cpptools-extension-pack\",\"uuid\":\"3957b2f6-f086-49b5-a7b4-5da772123130\"},\"displayName\":\"C/C++ Extension Pack\"},{\"identifier\":{\"id\":\"ms-vscode.cpptools-themes\",\"uuid\":\"99b17261-8f6e-45f0-9ad5-a69c6f509a4f\"},\"displayName\":\"C/C++ Themes\"},{\"identifier\":{\"id\":\"ms-vscode.vscode-serial-monitor\",\"uuid\":\"17dcad22-0c4b-428f-8a04-5d2629f1480e\"},\"displayName\":\"Serial Monitor\"},{\"identifier\":{\"id\":\"raspberry-pi.raspberry-pi-pico\",\"uuid\":\"38fd19eb-86e9-4f0b-a7ee-d61406931ba9\"},\"displayName\":\"Raspberry Pi Pico\"},{\"identifier\":{\"id\":\"twxs.cmake\",\"uuid\":\"2be7cf14-2603-402e-9771-fd79df83cdf8\"},\"displayName\":\"CMake\"}]"}

0 comments on commit 45507c7

Please sign in to comment.