zephyr README

The project's README from github.com/zephyrproject-rtos/zephyr. As one markdown file: README.md.

.. raw:: html

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-A, Cortex-R, Cortex-M), Intel x86, ARC, Tensilica Xtensa, and RISC-V, SPARC, MIPS, and a large number of supported boards_.

.. below included in doc/introduction/introduction.rst

Getting Started


Welcome to Zephyr! See the Introduction to Zephyr_ for a high-level overview, and the documentation's Getting Started Guide_ to start developing.

.. start_include_here

Community Support


Community support is provided via mailing lists and Discord; see the Resources below for details.

.. _project-resources:

Resources


Here's a quick summary of resources to help you find your way around:

Getting Started

| 📖 Zephyr Documentation_ | 🚀 Getting Started Guide_ | 🙋🏽 Tips when asking for help_ | 💻 Code samples_

Code and Development

| 🌐 Source Code Repository_ | 📦 Releases_ | 🤝 Contribution Guide_

Community and Support

| 💬 Discord Server_ for real-time community discussions | 📧 User mailing list ([email protected])_ | 📧 Developer mailing list ([email protected])_ | 📬 Other project mailing lists_ | 📚 Project Wiki_

Issue Tracking and Security

| 🐛 GitHub Issues_ | 🔒 Security documentation_ | 🛡️ Security Advisories Repository_ | ⚠️ Report security vulnerabilities at [email protected]

Additional Resources

| 🌐 Zephyr Project Website_ | 📺 Zephyr Tech Talks_

.. _Zephyr Project Website: https://www.zephyrproject.org .. _Discord Server: https://chat.zephyrproject.org .. _supported boards: https://docs.zephyrproject.org/latest/boards/index.html .. _Zephyr Documentation: https://docs.zephyrproject.org .. _Introduction to Zephyr: https://docs.zephyrproject.org/latest/introduction/index.html .. _Getting Started Guide: https://docs.zephyrproject.org/latest/develop/getting_started/index.html .. _Contribution Guide: https://docs.zephyrproject.org/latest/contribute/index.html .. _Source Code Repository: https://github.com/zephyrproject-rtos/zephyr .. _GitHub Issues: https://github.com/zephyrproject-rtos/zephyr/issues .. _Releases: https://github.com/zephyrproject-rtos/zephyr/releases .. _Project Wiki: https://github.com/zephyrproject-rtos/zephyr/wiki .. _User mailing list ([email protected]): https://lists.zephyrproject.org/g/users .. _Developer mailing list ([email protected]): https://lists.zephyrproject.org/g/devel .. _Other project mailing lists: https://lists.zephyrproject.org/g/main/subgroups .. _Code samples: https://docs.zephyrproject.org/latest/samples/index.html .. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html .. _Security Advisories Repository: https://github.com/zephyrproject-rtos/zephyr/security .. _Tips when asking for help: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help .. _Zephyr Tech Talks: https://www.zephyrproject.org/tech-talks

zephyr (zephyrproject-rtos/zephyr)

arm
Searching Database…

16.8K ·GitHub
What is this?Zephyr is an open source real-time operating system (RTOS) — a small-footprint kernel for resource-constrained embedded devices, supporting many hardware architectures and built with security in mind.
So is it an OS I flash onto a chip, or a library for my desktop app?It is a full embedded OS: you write your application against the Zephyr kernel, build a firmware image and flash it onto the target board. It does not run on your desktop.
How do I get started with it?Start with the Getting Started Guide in the official Zephyr documentation, which walks you through setup and your first build; the repository also provides code samples to start from.
What do I need on my machine to build for it?A cross-compilation toolchain for your target board: the kernel is written in C and the project builds with Make. The Getting Started Guide covers installing and configuring the toolchain.
What kind of devices is it aimed at?Resource-constrained embedded systems of all sizes — from simple environmental sensors and LED wearables to smart watches and IoT wireless gateways.
Which chips and boards can it actually run on?ARM (Cortex-A, Cortex-R, Cortex-M), Intel x86, ARC, Tensilica Xtensa, RISC-V, SPARC and MIPS, plus a large number of ready-made supported boards.
Does it support Bluetooth out of the box?Yes — Bluetooth and Bluetooth Low Energy are listed among the project's core topics, which lines up with the wearables and IoT wireless gateways Zephyr targets.
Is this a mature project or a hobby experiment?It is mature: the repository dates back to 2016, has around 16.8k stars, and the project maintains regular releases, tech talks and a formal security advisory process.
Size
948.7 MB
Stars
16.8K
Age
10y
Commits · 90 Days