You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
122 lines
3.4 KiB
122 lines
3.4 KiB
.. |
|
Zephyr Project documentation main file |
|
|
|
.. _zephyr-home: |
|
|
|
Zephyr Project Documentation |
|
############################ |
|
|
|
.. only:: release |
|
|
|
Welcome to the Zephyr Project's documentation for version |version|. |
|
|
|
Documentation for the latest (main) development branch of Zephyr |
|
can be found at https://docs.zephyrproject.org/ |
|
|
|
.. only:: (development or daily) |
|
|
|
**Welcome to the Zephyr Project's documentation |
|
for the main tree under development** (version |version|). |
|
|
|
Use the version selection menu on the left to view |
|
documentation for a specific version of Zephyr. |
|
|
|
|
|
.. raw:: html |
|
|
|
<ul class="grid"> |
|
<li class="grid-item"> |
|
<a href="introduction/index.html"> |
|
<img alt="" src="_static/images/kite.png"/> |
|
<h2>Introduction</h2> |
|
</a> |
|
<p>Architecture, features & licensing details</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="develop/getting_started/index.html"> |
|
<span class="grid-icon fa fa-map-signs"></span> |
|
<h2>Getting Started Guide</h2> |
|
</a> |
|
<p>Set up Zephyr, build & run a sample application</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="samples/index.html"> |
|
<span class="grid-icon fa fa-cogs"></span> |
|
<h2>Samples and Demos</h2> |
|
</a> |
|
<p>Explore samples and demos for various boards</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="boards/index.html"> |
|
<span class="grid-icon fa fa-object-group"></span> |
|
<h2>Supported Boards</h2> |
|
</a> |
|
<p>List of supported boards and platforms</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="hardware/index.html"> |
|
<span class="grid-icon fa fa-sign-in"></span> |
|
<h2>Hardware Support</h2> |
|
</a> |
|
<p>Supported hardware and porting guides</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="security/index.html"> |
|
<span class="grid-icon fa fa-lock"></span> |
|
<h2>Security</h2> |
|
</a> |
|
<p>Security processes and guidelines</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="services/index.html"> |
|
<span class="grid-icon fa fa-puzzle-piece"></span> |
|
<h2>OS Services</h2> |
|
</a> |
|
<p>OS Services and usage guides</p> |
|
</li> |
|
<li class="grid-item"> |
|
<a href="contribute/index.html"> |
|
<span class="grid-icon fa fa-github"></span> |
|
<h2>Contribution Guidelines</h2> |
|
</a> |
|
<p>How to submit patches and contribute to Zephyr</p> |
|
</li> |
|
</ul> |
|
|
|
For information about the changes and additions for past releases, please |
|
consult the published :ref:`zephyr_release_notes` documentation. |
|
|
|
The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in |
|
the LICENSE file in the project's `GitHub repo`_). The Zephyr OS also |
|
imports or reuses packages, scripts, and other files that use other |
|
licensing, as described in :ref:`Zephyr_Licensing`. |
|
|
|
.. toctree:: |
|
:maxdepth: 1 |
|
:hidden: |
|
|
|
introduction/index.rst |
|
develop/index.rst |
|
kernel/index.rst |
|
services/index.rst |
|
build/index.rst |
|
connectivity/index.rst |
|
hardware/index.rst |
|
contribute/index.rst |
|
project/index.rst |
|
security/index.rst |
|
safety/index.rst |
|
samples/index.rst |
|
boards/index.rst |
|
releases/index.rst |
|
|
|
Indices and Tables |
|
****************** |
|
|
|
* :ref:`glossary` |
|
* :ref:`genindex` |
|
|
|
.. _Apache 2.0 license: |
|
https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE |
|
|
|
.. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
|
|
|