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