liuguo09/zephyr

.. 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-M,
Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of
supported boards_.

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

.. start_include_here

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.

Community Support

---

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

.. _project-resources:

Resources

---

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

• Help: Asking for Help Tips_
• Documentation: http://docs.zephyrproject.org (Getting Started Guide_)
• Source Code: https://github.com/zephyrproject-rtos/zephyr is the main
  repository; https://elixir.bootlin.com/zephyr/latest/source contains a
  searchable index
• Releases: https://github.com/zephyrproject-rtos/zephyr/releases
• Samples and example code: see Sample and Demo Code Examples_
• Mailing Lists: users@lists.zephyrproject.org and
  devel@lists.zephyrproject.org are the main user and developer mailing lists,
  respectively. You can join the developer's list and search its archives at
  Zephyr Development mailing list. The other Zephyr mailing list subgroups have their own archives and sign-up pages.
• Nightly CI Build Status: https://lists.zephyrproject.org/g/builds
  The builds@lists.zephyrproject.org mailing list archives the CI
  (shippable) nightly build results.
• Chat: Zephyr's Slack workspace is https://zephyrproject.slack.com. Use
  this Slack Invite_ to register.
• Contributing: see the Contribution Guide_
• Wiki: Zephyr GitHub wiki_
• Issues: https://github.com/zephyrproject-rtos/zephyr/issues
• Security Issues: Email vulnerabilities@zephyrproject.org to report
  security issues; also see our Security_ documentation. Security issues are
  tracked separately at https://zephyrprojectsec.atlassian.net.
• Zephyr Project Website: https://zephyrproject.org

.. _Slack Invite: https://tinyurl.com/y5glwylp
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
.. _Zephyr Documentation: http://docs.zephyrproject.org
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
.. _Asking for Help Tips: https://docs.zephyrproject.org/latest/guides/getting-help.html