xref: /aosp_15_r20/external/pigweed/pw_ide/ts/pigweed-vscode/README.md (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker# Pigweed Extension for Visual Studio Code
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard WorkerBuild [Pigweed](https://pigweed.dev) projects efficiently and effectively in
4*61c4878aSAndroid Build Coastguard WorkerVisual Studio Code!
5*61c4878aSAndroid Build Coastguard Worker
6*61c4878aSAndroid Build Coastguard WorkerFeatures include:
7*61c4878aSAndroid Build Coastguard Worker
8*61c4878aSAndroid Build Coastguard Worker* High-quality C/C++ code intelligence for embedded systems projects using
9*61c4878aSAndroid Build Coastguard Worker  [clangd](https://clangd.llvm.org/) integrated directly with your project's
10*61c4878aSAndroid Build Coastguard Worker  Bazel build graph
11*61c4878aSAndroid Build Coastguard Worker
12*61c4878aSAndroid Build Coastguard Worker* Bundled core Bazel tools, letting you get started immediately without the need
13*61c4878aSAndroid Build Coastguard Worker  to install global system dependencies
14*61c4878aSAndroid Build Coastguard Worker
15*61c4878aSAndroid Build Coastguard Worker* Interactive browsing, building, and running Bazel targets
16*61c4878aSAndroid Build Coastguard Worker
17*61c4878aSAndroid Build Coastguard Worker* Built-in tools for building firmware, flashing it to your device, and
18*61c4878aSAndroid Build Coastguard Worker  communicating with your device once it's running
19*61c4878aSAndroid Build Coastguard Worker
20*61c4878aSAndroid Build Coastguard Worker## Getting Started
21*61c4878aSAndroid Build Coastguard Worker
22*61c4878aSAndroid Build Coastguard WorkerJust install this extension and open your Pigweed project. The extension will
23*61c4878aSAndroid Build Coastguard Workerprompt you to set up a few things on first run.
24*61c4878aSAndroid Build Coastguard Worker
25*61c4878aSAndroid Build Coastguard WorkerFor more details, check out the [full documentation](https://pigweed.dev/pw_ide/guide/vscode).
26*61c4878aSAndroid Build Coastguard Worker
27*61c4878aSAndroid Build Coastguard Worker## Found a bug?
28*61c4878aSAndroid Build Coastguard Worker
29*61c4878aSAndroid Build Coastguard WorkerRun `Pigweed: File Bug` to let us know!
30*61c4878aSAndroid Build Coastguard Worker
31*61c4878aSAndroid Build Coastguard Worker## Pre-Release Channel
32*61c4878aSAndroid Build Coastguard Worker
33*61c4878aSAndroid Build Coastguard WorkerBetween main channel releases, pre-release versions will be published off of
34*61c4878aSAndroid Build Coastguard WorkerPigweed's `main` branch. Features available in pre-release versions can be
35*61c4878aSAndroid Build Coastguard Workerdiscovered in Pigweed's [changelog](https://pigweed.dev/changelog.html) or in
36*61c4878aSAndroid Build Coastguard Workerthe [list of merged changes](https://pigweed-review.googlesource.com/q/status:merged).
37*61c4878aSAndroid Build Coastguard Worker
38*61c4878aSAndroid Build Coastguard WorkerYou can opt in to the pre-release version on the Pigweed extension page in the
39*61c4878aSAndroid Build Coastguard Workerextension marketplace. Be warned that features in the pre-release versions may
40*61c4878aSAndroid Build Coastguard Workernot entirely work, and pre-release versions may break existing functionality.
41*61c4878aSAndroid Build Coastguard Worker
42*61c4878aSAndroid Build Coastguard WorkerYou can always revert back to the main channel version in the Pigweed extension
43*61c4878aSAndroid Build Coastguard Workerpage.
44*61c4878aSAndroid Build Coastguard Worker
45*61c4878aSAndroid Build Coastguard Worker## Developing
46*61c4878aSAndroid Build Coastguard Worker
47*61c4878aSAndroid Build Coastguard WorkerIf you want to contribute to this extension, or just build it locally, refer
48*61c4878aSAndroid Build Coastguard Workerto the [development docs](https://pigweed.dev/pw_ide/guide/vscode/development.html).
49