Skip to content

Latest commit

 

History

History
130 lines (108 loc) · 3.95 KB

index.rst

File metadata and controls

130 lines (108 loc) · 3.95 KB

Zephyr Project Documentation

.. only:: release

   Welcome to the Zephyr Project's documentation version |version|!

   Documentation for the development branch of Zephyr can be found at
   https://docs.zephyrproject.org/

.. only:: (development or daily)

   Welcome to the Zephyr Project's documentation. This is the documentation of the
   master tree under development (version |version|).

For information about the changes and additions for 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`.

  • Introducing the Zephyr Project: overview, architecture, features, and licensing

  • Follow this guide to set up a Zephyr development environment on your system, and then build and run a sample application.

  • As an open-source project, we welcome and encourage the community to submit patches directly to the project.

  • A list of samples and demos that can run on a variety of boards supported by Zephyr

  • API Documentation, Zephyr configuration, and subsystem Reference

  • Requirements, processes, and developer guidelines for ensuring security is addressed within the Zephyr project.

  • List of supported boards and platforms.

  • User and Developer Guides, including tools and tips

.. only:: html

   Sections
   ********

.. toctree::
   :maxdepth: 1

   introduction/index.rst
   getting_started/index.rst
   contribute/index.rst
   development_process/index.rst
   application/index.rst
   reference/index.rst
   guides/index.rst
   security/index.rst
   samples/index.rst
   boards/index.rst
   releases/index.rst

.. only:: html

   Indices and Tables
   ******************