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 src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
14   <a href="https://scorecard.dev/viewer/?uri=github.com/zephyrproject-rtos/zephyr"><img src="https://api.securityscorecards.dev/projects/github.com/zephyrproject-rtos/zephyr/badge"></a>
15   <a href="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain"><img src="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml/badge.svg?event=push"></a>
16
17
18The Zephyr Project is a scalable real-time operating system (RTOS) supporting
19multiple hardware architectures, optimized for resource constrained devices,
20and built with security in mind.
21
22The Zephyr OS is based on a small-footprint kernel designed for use on
23resource-constrained systems: from simple embedded environmental sensors and
24LED wearables to sophisticated smart watches and IoT wireless gateways.
25
26The Zephyr kernel supports multiple architectures, including ARM (Cortex-A,
27Cortex-R, Cortex-M), Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V,
28SPARC, MIPS, and a large number of `supported boards`_.
29
30.. below included in doc/introduction/introduction.rst
31
32
33Getting Started
34***************
35
36Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
37and the documentation's `Getting Started Guide`_ to start developing.
38
39.. start_include_here
40
41Community Support
42*****************
43
44Community support is provided via mailing lists and Discord; see the Resources
45below for details.
46
47.. _project-resources:
48
49Resources
50*********
51
52Here's a quick summary of resources to help you find your way around:
53
54Getting Started
55---------------
56
57  | �� `Zephyr Documentation`_
58  | �� `Getting Started Guide`_
59  | ���� `Tips when asking for help`_
60  | �� `Code samples`_
61
62Code and Development
63--------------------
64
65  | �� `Source Code Repository`_
66  | �� `Releases`_
67  | �� `Contribution Guide`_
68
69Community and Support
70---------------------
71
72  | �� `Discord Server`_ for real-time community discussions
73  | �� `User mailing list (users@lists.zephyrproject.org)`_
74  | �� `Developer mailing list (devel@lists.zephyrproject.org)`_
75  | �� `Other project mailing lists`_
76  | �� `Project Wiki`_
77
78Issue Tracking and Security
79---------------------------
80
81  | �� `GitHub Issues`_
82  | �� `Security documentation`_
83  | ��️ `Security Advisories Repository`_
84  | ⚠️ Report security vulnerabilities at vulnerabilities@zephyrproject.org
85
86Additional Resources
87--------------------
88  | �� `Zephyr Project Website`_
89  | �� `Zephyr Tech Talks`_
90
91.. _Zephyr Project Website: https://www.zephyrproject.org
92.. _Discord Server: https://chat.zephyrproject.org
93.. _supported boards: https://docs.zephyrproject.org/latest/boards/index.html
94.. _Zephyr Documentation: https://docs.zephyrproject.org
95.. _Introduction to Zephyr: https://docs.zephyrproject.org/latest/introduction/index.html
96.. _Getting Started Guide: https://docs.zephyrproject.org/latest/develop/getting_started/index.html
97.. _Contribution Guide: https://docs.zephyrproject.org/latest/contribute/index.html
98.. _Source Code Repository: https://github.com/zephyrproject-rtos/zephyr
99.. _GitHub Issues: https://github.com/zephyrproject-rtos/zephyr/issues
100.. _Releases: https://github.com/zephyrproject-rtos/zephyr/releases
101.. _Project Wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
102.. _User mailing list (users@lists.zephyrproject.org): https://lists.zephyrproject.org/g/users
103.. _Developer mailing list (devel@lists.zephyrproject.org): https://lists.zephyrproject.org/g/devel
104.. _Other project mailing lists: https://lists.zephyrproject.org/g/main/subgroups
105.. _Code samples: https://docs.zephyrproject.org/latest/samples/index.html
106.. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
107.. _Security Advisories Repository: https://github.com/zephyrproject-rtos/zephyr/security
108.. _Tips when asking for help: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
109.. _Zephyr Tech Talks: https://www.zephyrproject.org/tech-talks
110