1..
2    Zephyr Project documentation main file
3
4.. _zephyr-home:
5
6Zephyr Project Documentation
7############################
8
9.. only:: release
10
11   Welcome to the Zephyr Project's documentation for version |version|.
12
13   Documentation for the latest (main) development branch of Zephyr
14   can be found at https://docs.zephyrproject.org/
15
16.. only:: (development or daily)
17
18   **Welcome to the Zephyr Project's documentation
19   for the main tree under development** (version |version|).
20
21Use the version selection menu on the left to view
22documentation for a specific version of Zephyr.
23
24For information about the changes and additions for releases, please
25consult the published :ref:`zephyr_release_notes` documentation.
26
27The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in
28the LICENSE file in the project's `GitHub repo`_).  The Zephyr OS also
29imports or reuses packages, scripts, and other files that use other
30licensing, as described in :ref:`Zephyr_Licensing`.
31
32
33.. raw:: html
34
35   <ul class="grid">
36       <li class="grid-item">
37	   <a href="introduction/index.html">
38	       <img alt="" src="_static/images/kite.png"/>
39	       <h2>Introduction</h2>
40	   </a>
41	   <p>Introducing the Zephyr Project: overview, architecture, features, and licensing</p>
42       </li>
43       <li class="grid-item">
44	   <a href="getting_started/index.html">
45               <span class="grid-icon fa fa-map-signs"></span>
46	       <h2>Getting Started Guide</h2>
47	   </a>
48	   <p>Follow this guide to set up a Zephyr development environment on your
49	       system, and then build and run a sample application.</p>
50       </li>
51       <li class="grid-item">
52	   <a href="contribute/index.html">
53               <span class="grid-icon fa fa-github"></span>
54	       <h2>Contribution Guidelines</h2>
55	   </a>
56	   <p>As an open-source project, we welcome and encourage the community
57           to submit patches directly to the project.</p>
58       </li>
59       <li class="grid-item">
60	   <a href="samples/index.html">
61               <span class="grid-icon fa fa-cogs"></span>
62	       <h2>Samples and Demos</h2>
63	   </a>
64	   <p>A list of samples and demos that can run on a variety of boards supported
65	       by Zephyr</p>
66       </li>
67       <li class="grid-item">
68	   <a href="reference/index.html">
69               <span class="grid-icon fa fa-sign-in"></span>
70	       <h2>API Reference</h2>
71	   </a>
72	   <p>API Documentation, Zephyr configuration, and subsystem Reference</p>
73       </li>
74       <li class="grid-item">
75	   <a href="security/index.html">
76               <span class="grid-icon fa fa-lock"></span>
77	       <h2>Security</h2>
78	   </a>
79	   <p>Requirements, processes, and developer guidelines for ensuring security is addressed within the Zephyr project.</p>
80       </li>
81       <li class="grid-item">
82	   <a href="boards/index.html">
83               <span class="grid-icon fa fa-object-group"></span>
84	       <h2>Supported Boards</h2>
85	   </a>
86	   <p>List of supported boards and platforms.</p>
87       </li>
88       <li class="grid-item">
89	   <a href="guides/index.html">
90               <span class="grid-icon fa fa-puzzle-piece"></span>
91	       <h2>User and Developer Guides</h2>
92	   </a>
93	   <p>User and Developer Guides, including tools and tips</p>
94       </li>
95   </ul>
96
97Sections
98********
99
100.. toctree::
101   :maxdepth: 1
102   :caption: Contents
103
104   introduction/index.rst
105   getting_started/index.rst
106   contribute/index.rst
107   development_process/index.rst
108   guides/build/index.rst
109   application/index.rst
110   reference/index.rst
111   guides/index.rst
112   security/index.rst
113   samples/index.rst
114   boards/index.rst
115   releases/index.rst
116
117Indices and Tables
118******************
119
120* :ref:`configuration_options`
121* :ref:`glossary`
122* :ref:`genindex`
123
124.. _Apache 2.0 license:
125   https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE
126
127.. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
128