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