Skip to content
Primary GIT Repository for the Zephyr Project
C C++ Assembly Python CMake Perl
Branch: master
Clone or download
Pull request Compare This branch is 1 commit ahead, 11015 commits behind zephyrproject-rtos:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
.known-issues
arch
boards
cmake
doc
drivers
dts
ext
include
kernel
lib
misc
samples
scripts
soc
subsys
tests
.checkpatch.conf
.clang-format
.codecov.yml
.gitattributes
.gitignore
.gitlint
.mailmap
.shippable.yml
.uncrustify.cfg
CMakeLists.txt
CODEOWNERS
CONTRIBUTING.rst
Kconfig
Kconfig.zephyr
LICENSE
Makefile
README.rst
VERSION
version.h.in
zephyr-env.cmd
zephyr-env.sh

README.rst

The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple hardware architectures, optimized for resource constrained devices, and built with security in mind.

The Zephyr OS is based on a small-footprint kernel designed for use on resource-constrained systems: from simple embedded environmental sensors and LED wearables to sophisticated smart watches and IoT wireless gateways.

The Zephyr kernel supports multiple architectures, including ARM Cortex-M, Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of supported boards.

Getting Started

To start developing Zephyr applications refer to the Getting Started Guide in the Zephyr Documentation pages. A brief introduction to Zephyr can be found in the Zephyr Introduction page.

Community Support

The Zephyr Project Developer Community includes developers from member organizations and the general community all joining in the development of software within the Zephyr Project. Members contribute and discuss ideas, submit bugs and bug fixes, and provide training. They also help those in need through the community's forums such as mailing lists and IRC channels. Anyone can join the developer community and the community is always willing to help its members and the User Community to get the most out of the Zephyr Project.

Welcome to the Zephyr community!

Resources

Here's a quick summary of resources to find your way around the Zephyr Project support systems:

  • Zephyr Project Website: The https://zephyrproject.org website is the central source of information about the Zephyr Project. On this site, you'll find background and current information about the project as well as all the relevant links to project material.

  • Releases: Source code for Zephyr kernel releases are available at https://zephyrproject.org/developers/#downloads. On this page, you'll find release information, and links to download or clone source code from our GitHub repository. You'll also find links for the Zephyr SDK, a moderated collection of tools and libraries used to develop your applications.

  • Source Code in GitHub: Zephyr Project source code is maintained on a public GitHub repository at https://github.com/zephyrproject-rtos/zephyr. You'll find information about getting access to the repository and how to contribute to the project in this Contribution Guide document.

  • Samples Code: In addition to the kernel source code, there are also many documented Sample and Demo Code Examples that can help show you how to use Zephyr services and subsystems.

  • Documentation: Extensive Project technical documentation is developed along with the Zephyr kernel itself, and can be found at http://docs.zephyrproject.org. Additional documentation is maintained in the Zephyr GitHub wiki.

  • Cross-reference: Source code cross-reference for the Zephyr kernel and samples code is available at https://elixir.bootlin.com/zephyr/latest/source.

  • Issue Reporting and Tracking: Requirements and Issue tracking is done in the Github issues system: https://github.com/zephyrproject-rtos/zephyr/issues. You can browse through the reported issues and submit issues of your own.

  • Security-related Issue Reporting and Tracking: For security-related inquiries or reporting suspected security-related bugs in the Zephyr OS, please send email to vulnerabilities@zephyrproject.org. We will assess and fix flaws according to our security policy outlined in the Zephyr Project Security Overview.

    Security related issue tracking is done in JIRA. The location of this JIRA is https://zephyrprojectsec.atlassian.net.

  • Mailing List: The Zephyr Development mailing list is perhaps the most convenient way to track developer discussions and to ask your own support questions to the Zephyr project community. There are also specific Zephyr mailing list subgroups for announcements, builds, marketing, and Technical Steering Committee notes, for example. You can read through the message archives to follow past posts and discussions, a good thing to do to discover more about the Zephyr project.

  • Chatting: You can chat online with the Zephyr project developer community and other users in two ways:

    • On Slack: Zephyr has dedicated channels on Slack. To register, use the following Slack Invite.
    • IRC channel #zephyrproject on the freenode.net IRC server. You can use the http://webchat.freenode.net web client or use a client-side application such as pidgin (Note that all discussions have moved to Slack, although we still have many developers still available on the IRC channel).
You can’t perform that action at this time.