README.rst
May 16, 2025 · View on GitHub
.. 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 (users@lists.zephyrproject.org)_
| 📧 Developer mailing list (devel@lists.zephyrproject.org)_
| 📬 Other project mailing lists_
| 📚 Project Wiki_
Issue Tracking and Security
| 🐛 GitHub Issues_
| 🔒 Security documentation_
| 🛡️ Security Advisories Repository_
| ⚠️ Report security vulnerabilities at vulnerabilities@zephyrproject.org
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 (users@lists.zephyrproject.org): https://lists.zephyrproject.org/g/users .. _Developer mailing list (devel@lists.zephyrproject.org): 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