• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _docs-root:
2
3=======
4Pigweed
5=======
6*Sustained, robust, and rapid embedded product development for large teams*
7
8.. raw:: html
9
10   <!-- Add a little space between the H2 and the cards. This is an edge case
11        that only occurs on the homepage so it's best to just hack the fix
12        locally here. -->
13   <br>
14
15.. grid:: 1
16
17   .. grid-item-card:: :octicon:`rocket` Get started
18      :link: docs-get-started
19      :link-type: ref
20      :class-item: sales-pitch-cta-primary
21
22      Create a new project, integrate Pigweed into an existing project, browse
23      example apps, or contribute to upstream Pigweed
24
25----------------
26What is Pigweed?
27----------------
28.. raw:: html
29
30   <!-- Add a little space between the H2 and the cards. This is an edge case
31        that only occurs on the homepage so it's best to just hack the fix
32        locally here. -->
33   <br>
34
35.. grid:: 2
36
37   .. grid-item-card:: :octicon:`code-square` Libraries
38      :link: docs-concepts-embedded-development-libraries
39      :link-type: ref
40      :class-item: sales-pitch-cta-secondary
41
42      Over 150 libraries ("modules") enabling you to use modern C++ and
43      software development best practices without compromising performance,
44      code size, or memory
45
46   .. grid-item-card:: :octicon:`tools` Automation
47      :link: docs-concepts-build-system
48      :link-type: ref
49      :class-item: sales-pitch-cta-secondary
50
51      Easier automated building, testing, and linting for Bazel, GN,
52      and CMake projects
53
54.. grid:: 2
55
56   .. grid-item-card:: :octicon:`container` Environments
57      :link: docs-concepts-development-environment
58      :link-type: ref
59      :class-item: sales-pitch-cta-secondary
60
61      Hermetic and replicable development environments for your entire team -
62      no more struggling with toolchains and "it worked on my machine"
63
64   .. grid-item-card:: :octicon:`stack` Frameworks
65      :link: docs-concepts-full-framework
66      :link-type: ref
67      :class-item: sales-pitch-cta-secondary
68
69      Turnkey solutions for new projects that want to make full use of
70      everything that Pigweed offers
71
72--------------------
73Who's using Pigweed?
74--------------------
75Pigweed has shipped on millions of devices.
76
77--------------------
78Showcase: pw_console
79--------------------
80:ref:`module-pw_console` is our multi-purpose, pluggable REPL and log viewer.
81It's designed to be a complete development and manufacturing solution for
82interacting with hardware devices via :ref:`module-pw_rpc` over a
83:ref:`module-pw_hdlc` transport. Gone are the days of hacking together a REPL
84and log viewer for each new project!
85
86.. figure:: pw_console/images/python_completion.png
87   :alt: Using pw_console to interact with a device
88
89   Using pw_console to interact with a device
90
91.. _docs-root-changelog:
92
93---------------------
94What's new in Pigweed
95---------------------
96.. include:: changelog.rst
97   :start-after: .. changelog_highlights_start
98   :end-before: .. changelog_highlights_end
99
100See :ref:`docs-changelog-latest` in our changelog for details.
101
102----------
103Talk to us
104----------
105.. raw:: html
106
107   <!-- Add a little space between the H2 and the cards. This is an edge case
108        that only occurs on the homepage so it's best to just hack the fix
109        locally here. -->
110   <br>
111
112.. grid:: 1
113
114   .. grid-item-card:: :octicon:`comment-discussion` Chat room
115      :link: https://discord.gg/M9NSeTA
116      :link-type: url
117      :class-item: sales-pitch-cta-secondary
118
119      For real-time discussion with the Pigweed team, head over to our Discord.
120
121.. grid:: 2
122
123   .. grid-item-card:: :octicon:`device-camera-video` Monthly community meeting
124      :link: https://discord.com/channels/691686718377558037/951228399119126548
125      :link-type: url
126      :class-item: sales-pitch-cta-secondary
127
128      .. pigweed-live::
129
130   .. grid-item-card:: :octicon:`bug` Issues
131      :link: https://pwbug.dev
132      :link-type: url
133      :class-item: sales-pitch-cta-secondary
134
135      Found a bug? Got a feature request? Please create a new issue in our
136      tracker.
137
138.. toctree::
139   :maxdepth: 1
140   :hidden:
141
142   Home <self>
143   docs/overview
144   docs/get_started/index
145   docs/concepts/index
146   targets
147   modules
148   changelog
149   Mailing List <https://groups.google.com/forum/#!forum/pigweed>
150   Chat Room <https://discord.gg/M9NSeTA>
151   docs/os/index
152   docs/size_optimizations
153   Code Editor Support <docs/editors>
154   third_party_support
155   Source Code <https://cs.pigweed.dev/pigweed>
156   Code Reviews <https://pigweed-review.googlesource.com>
157   Issue Tracker <https://issues.pigweed.dev/issues?q=status:open>
158   docs/contributing/index
159   docs/infra/index
160   Automated Analysis <automated_analysis>
161   Build System <build_system>
162   SEEDs <seed/0000-index>
163   kudzu/docs
164   Eng Blog <docs/blog/index>
165