aboutsummaryrefslogtreecommitdiff
path: root/pw_ide/ts/pigweed-vscode/README.md
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2024-03-12 23:07:32 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2024-03-12 23:07:32 +0000
commit47562fa92998f8f4289ae9a8048349067754d52e (patch)
treec1643be8ab17fc607cea748a8bb1d621a5964873 /pw_ide/ts/pigweed-vscode/README.md
parenteeec55b65fe2c3c7647bb70ea44b3c839eb1267c (diff)
parent646563934a3e2ee26f50171f94d95173a1662e2c (diff)
downloadpigweed-47562fa92998f8f4289ae9a8048349067754d52e.tar.gz
Snap for 11566117 from 646563934a3e2ee26f50171f94d95173a1662e2c to sdk-releaseplatform-tools-35.0.1
Change-Id: Iec629b181a2c6905754a4c340e334884e13fd3b4
Diffstat (limited to 'pw_ide/ts/pigweed-vscode/README.md')
-rw-r--r--pw_ide/ts/pigweed-vscode/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/pw_ide/ts/pigweed-vscode/README.md b/pw_ide/ts/pigweed-vscode/README.md
new file mode 100644
index 000000000..434603d7a
--- /dev/null
+++ b/pw_ide/ts/pigweed-vscode/README.md
@@ -0,0 +1,25 @@
+# Pigweed Extension for Visual Studio Code
+
+This is highly experimental!
+
+## Developing
+
+- Ensure that you have `npm` installed globally; this doesn't use the
+ distribution provided by Pigweed yet.
+
+- Open the `pigweed/pw_ide/vscode` directory directly in Visual Studio Code.
+
+- Run `npm install` to add all dependencies.
+
+- Run "Run Extension" in the "Run and Debug" sidebar, or simply hit F5. A new
+ Visual Studio Code window will open with the extension installed.
+
+- Make changes. The build will update automatically. Click the little green
+ circle-with-an-arrow icon at the top of your development window to update
+ the extension development host with the new build.
+
+## Building
+
+- Install the build tool: `npm install -g @vscode/vsce`
+
+- Build the VSIX: `vsce package`