2017-08-10 05:43:50 +08:00
|
|
|
.. raw:: html
|
|
|
|
|
|
2018-08-01 19:35:53 +08:00
|
|
|
<a href="https://www.zephyrproject.org">
|
|
|
|
|
<p align="center">
|
2022-11-18 01:08:37 +08:00
|
|
|
<picture>
|
|
|
|
|
<source media="(prefers-color-scheme: dark)" srcset="doc/_static/images/logo-readme-dark.svg">
|
|
|
|
|
<source media="(prefers-color-scheme: light)" srcset="doc/_static/images/logo-readme-light.svg">
|
|
|
|
|
<img src="doc/_static/images/logo-readme-light.svg">
|
|
|
|
|
</picture>
|
2018-08-01 19:35:53 +08:00
|
|
|
</p>
|
|
|
|
|
</a>
|
|
|
|
|
|
2017-08-10 05:43:50 +08:00
|
|
|
<a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
|
|
|
|
|
src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
|
2021-11-24 04:19:52 +08:00
|
|
|
<a
|
|
|
|
|
href="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain">
|
2017-10-04 04:25:17 +08:00
|
|
|
<img
|
2021-11-24 04:19:52 +08:00
|
|
|
src="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml/badge.svg?event=push"></a>
|
2017-10-04 04:25:17 +08:00
|
|
|
|
2017-08-10 05:43:50 +08:00
|
|
|
|
2017-05-10 06:38:30 +08:00
|
|
|
The Zephyr Project is a scalable real-time operating system (RTOS) supporting
|
2017-04-29 22:11:05 +08:00
|
|
|
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.
|
|
|
|
|
|
2022-05-05 23:33:51 +08:00
|
|
|
The Zephyr kernel supports multiple architectures, including ARM (Cortex-A,
|
|
|
|
|
Cortex-R, Cortex-M), Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V,
|
|
|
|
|
SPARC, MIPS, and a large number of `supported boards`_.
|
2017-04-29 22:11:05 +08:00
|
|
|
|
2017-08-10 05:43:50 +08:00
|
|
|
.. below included in doc/introduction/introduction.rst
|
|
|
|
|
|
|
|
|
|
|
2018-08-02 18:15:07 +08:00
|
|
|
Getting Started
|
|
|
|
|
***************
|
|
|
|
|
|
2019-04-18 02:53:45 +08:00
|
|
|
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
|
|
|
|
|
and the documentation's `Getting Started Guide`_ to start developing.
|
2018-08-02 18:15:07 +08:00
|
|
|
|
2021-07-03 21:05:06 +08:00
|
|
|
.. start_include_here
|
|
|
|
|
|
2017-04-29 22:11:05 +08:00
|
|
|
Community Support
|
|
|
|
|
*****************
|
|
|
|
|
|
2021-09-01 20:33:01 +08:00
|
|
|
Community support is provided via mailing lists and Discord; see the Resources
|
2019-04-18 02:53:45 +08:00
|
|
|
below for details.
|
2017-04-29 22:11:05 +08:00
|
|
|
|
2019-09-13 05:32:29 +08:00
|
|
|
.. _project-resources:
|
|
|
|
|
|
2017-04-29 22:11:05 +08:00
|
|
|
Resources
|
|
|
|
|
*********
|
|
|
|
|
|
2019-04-18 02:53:45 +08:00
|
|
|
Here's a quick summary of resources to help you find your way around:
|
|
|
|
|
|
2023-10-17 08:33:24 +08:00
|
|
|
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
|
