xref: /aosp_15_r20/external/pigweed/pw_ide/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_ide:
2
3------
4pw_ide
5------
6.. pigweed-module::
7   :name: pw_ide
8
9.. toctree::
10   :maxdepth: 1
11   :hidden:
12
13   guide/index
14   design/index
15
16Rich, modern IDE and code editor support for embedded systems Projects.
17
18Most modern software development takes advantage of language servers and
19advanced editor features to power experiences like:
20
21* Fast, accurate code navigation, including finding definitions,
22  implementations, and references
23
24* Code autocompletion based on a deep understanding of the code structure, not
25  just dictionary lookups
26
27* Instant compiler errors and warnings as you write your code
28
29Most embedded systems development still lacks these features.
30**When you use Pigweed, you get all of them!**
31
32.. grid:: 2
33
34   .. grid-item-card:: :octicon:`codescan` Visual Studio Code
35      :link: module-pw_ide-guide-vscode
36      :link-type: ref
37      :class-item: sales-pitch-cta-primary
38
39      Learn how to use Visual Studio Code for blazingly modern embedded software
40      development for Bazel-based Pigweed projects
41
42   .. grid-item-card:: :octicon:`terminal` pw_ide CLI
43      :link: module-pw_ide-guide-cli
44      :link-type: ref
45      :class-item: sales-pitch-cta-primary
46
47      Learn how to use the ``pw_ide`` command-line interface with
48      bootstrap-based Pigweed projects using GN or CMake
49
50.. grid:: 2
51
52   .. grid-item-card:: :octicon:`code` C/C++ Code Intelligence
53      :link: module-pw_ide-design-cpp
54      :link-type: ref
55      :class-item: sales-pitch-cta-primary
56
57      Learn about Pigweed's approach to IDE code intelligence for C/C++
58
59   .. grid-item-card:: :octicon:`project` Projects
60      :link: module-pw_ide-design-projects
61      :link-type: ref
62      :class-item: sales-pitch-cta-primary
63
64      Understand Pigweed project structure and how Pigweed's IDE features
65      interact with it
66