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
57Getting Started
58---------------
59
60  | �� `Zephyr Documentation`_
61  | �� `Getting Started Guide`_
62  | ���� `Tips when asking for help`_
63  | �� `Code samples`_
64
65Code and Development
66--------------------
67
68  | �� `Source Code Repository`_
69  | �� `Releases`_
70  | �� `Contribution Guide`_
71
72Community and Support
73---------------------
74
75  | �� `Discord Server`_ for real-time community discussions
76  | �� `User mailing list (users@lists.zephyrproject.org)`_
77  | �� `Developer mailing list (devel@lists.zephyrproject.org)`_
78  | �� `Other project mailing lists`_
79  | �� `Project Wiki`_
80
81Issue Tracking and Security
82---------------------------
83
84  | �� `GitHub Issues`_
85  | �� `Security documentation`_
86  | ��️ `Security Advisories Repository`_
87  | ⚠️ Report security vulnerabilities at vulnerabilities@zephyrproject.org
88
89Additional Resources
90--------------------
91  | �� `Zephyr Project Website`_
92  | �� `Zephyr Tech Talks`_
93
94.. _Zephyr Project Website: https://www.zephyrproject.org
95.. _Discord Server: https://chat.zephyrproject.org
96.. _supported boards: https://docs.zephyrproject.org/latest/boards/index.html
97.. _Zephyr Documentation: https://docs.zephyrproject.org
98.. _Introduction to Zephyr: https://docs.zephyrproject.org/latest/introduction/index.html
99.. _Getting Started Guide: https://docs.zephyrproject.org/latest/develop/getting_started/index.html
100.. _Contribution Guide: https://docs.zephyrproject.org/latest/contribute/index.html
101.. _Source Code Repository: https://github.com/zephyrproject-rtos/zephyr
102.. _GitHub Issues: https://github.com/zephyrproject-rtos/zephyr/issues
103.. _Releases: https://github.com/zephyrproject-rtos/zephyr/releases
104.. _Project Wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
105.. _User mailing list (users@lists.zephyrproject.org): https://lists.zephyrproject.org/g/users
106.. _Developer mailing list (devel@lists.zephyrproject.org): https://lists.zephyrproject.org/g/devel
107.. _Other project mailing lists: https://lists.zephyrproject.org/g/main/subgroups
108.. _Code samples: https://docs.zephyrproject.org/latest/samples/index.html
109.. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
110.. _Security Advisories Repository: https://github.com/zephyrproject-rtos/zephyr/security
111.. _Tips when asking for help: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
112.. _Zephyr Tech Talks: https://www.zephyrproject.org/tech-talks
113