]> Git Repo - pico-vscode.git/commitdiff
Add brief build instructions
authorwill-v-pi <[email protected]>
Tue, 2 Jul 2024 13:33:25 +0000 (14:33 +0100)
committerGitHub <[email protected]>
Tue, 2 Jul 2024 13:33:25 +0000 (14:33 +0100)
README.md

index 9f339fcd56de2ba7f50eba1bc14e0ada48c72097..d273101ad9db4f6dd4d5d83ba45eb8fae923c1b5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -60,3 +60,15 @@ This extension contributes the following settings:
 ### GitHub API Rate Limit ("Error while retrieving SDK and toolchain versions")
 
 If the extension fails to get available Pico SDK versions, it might be because of the GitHub API rate limit. You can create a personal access token (classic) with the `public_repo` scope and set it in the global ("User" not "Workspace") extension settings to increase the rate limit.
+
+## Build Instructions
+
+For advanced users who want to build the .vsix file for the extension, these instructions *might* work for you.
+
+1. Install npm (see [here](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows) for Windows instructions)
+2. Install yarn `npm install --global yarn`
+3. Install vsce `npm install --global @vscode/vsce`
+4. Run `yarn` from the project directory
+5. Run `vsce package` from the project directory
+
+This will produce a .vsix file which can then be installed in VS Code with `code --install-extension path-to.vsix` or in the GUI `Extensions > three dots > install vsix`.
This page took 0.030557 seconds and 4 git commands to generate.