1.. raw:: html
2
3   <a href="https://www.zephyrproject.org">
4     <p align="center">
5       <picture>
6         <source media="(prefers-color-scheme: dark)" srcset="doc/_static/images/logo-readme-dark.svg">
7         <source media="(prefers-color-scheme: light)" srcset="doc/_static/images/logo-readme-light.svg">
8         <img src="doc/_static/images/logo-readme-light.svg">
9       </picture>
10     </p>
11   </a>
12
13   <a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
14   src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
15   <a
16   href="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain">
17   <img
18   src="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml/badge.svg?event=push"></a>
19
20
21The Zephyr Project is a scalable real-time operating system (RTOS) supporting
22multiple hardware architectures, optimized for resource constrained devices,
23and built with security in mind.
24
25The Zephyr OS is based on a small-footprint kernel designed for use on
26resource-constrained systems: from simple embedded environmental sensors and
27LED wearables to sophisticated smart watches and IoT wireless gateways.
28
29The Zephyr kernel supports multiple architectures, including ARM (Cortex-A,
30Cortex-R, Cortex-M), Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V,
31SPARC, MIPS, and a large number of `supported boards`_.
32
33.. below included in doc/introduction/introduction.rst
34
35
36Getting Started
37***************
38
39Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
40and the documentation's `Getting Started Guide`_ to start developing.
41
42.. start_include_here
43
44Community Support
45*****************
46
47Community support is provided via mailing lists and Discord; see the Resources
48below for details.
49
50.. _project-resources:
51
52Resources
53*********
54
55Here's a quick summary of resources to help you find your way around:
56
57* **Help**: `Asking for Help Tips`_
58* **Documentation**: http://docs.zephyrproject.org (`Getting Started Guide`_)
59* **Source Code**: https://github.com/zephyrproject-rtos/zephyr is the main
60  repository; https://elixir.bootlin.com/zephyr/latest/source contains a
61  searchable index
62* **Releases**: https://github.com/zephyrproject-rtos/zephyr/releases
63* **Samples and example code**: see `Sample and Demo Code Examples`_
64* **Mailing Lists**: users@lists.zephyrproject.org and
65  devel@lists.zephyrproject.org are the main user and developer mailing lists,
66  respectively. You can join the developer's list and search its archives at
67  `Zephyr Development mailing list`_. The other `Zephyr mailing list
68  subgroups`_ have their own archives and sign-up pages.
69* **Nightly CI Build Status**: https://lists.zephyrproject.org/g/builds
70  The builds@lists.zephyrproject.org mailing list archives the CI nightly build results.
71* **Chat**: Real-time chat happens in Zephyr's Discord Server. Use
72  this `Discord Invite`_ to register.
73* **Contributing**: see the `Contribution Guide`_
74* **Wiki**: `Zephyr GitHub wiki`_
75* **Issues**: https://github.com/zephyrproject-rtos/zephyr/issues
76* **Security Issues**: Email vulnerabilities@zephyrproject.org to report
77  security issues; also see our `Security`_ documentation. Security issues are
78  tracked separately at https://zephyrprojectsec.atlassian.net.
79* **Zephyr Project Website**: https://zephyrproject.org
80
81.. _Discord Invite: https://chat.zephyrproject.org
82.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
83.. _Zephyr Documentation: http://docs.zephyrproject.org
84.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
85.. _Getting Started Guide: http://docs.zephyrproject.org/latest/develop/getting_started/index.html
86.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
87.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
88.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
89.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
90.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
91.. _Security: http://docs.zephyrproject.org/latest/security/index.html
92.. _Asking for Help Tips: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
93