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