Zephyr Project Documentation

Welcome to the Zephyr Project’s documentation. This is the documentation of the master tree under development (version 1.14.0-rc1).

For information about the changes and additions for releases, please consult the published 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 Licensing of Zephyr Project components.

  • Introduction

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

  • Getting Started Guide

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

  • Contribution Guidelines

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

  • Samples and Demos

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

  • API Reference

    API Documentation, Zephyr configuration, and subsystem Reference

  • Security

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

  • Supported Boards

    List of supported boards and platforms.

  • User and Developer Guides

    User and Developer Guides, including tools and tips

Sections

Indices and Tables