README.rst 3.88 KB
Newer Older
1
2
.. raw:: html

3
4
5
6
7
8
   <a href="https://www.zephyrproject.org">
     <p align="center">
       <img src="doc/images/Zephyr-Project.png">
     </p>
   </a>

9
10
   <a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
   src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
11
   <a href="https://buildkite.com/zephyr/zephyr">
12
   <img
13
   src="https://badge.buildkite.com/f5bd0dc88306cee17c9b38e78d11bb74a6291e3f40e7d13f31.svg?branch=master"></a>
14

15

16
The Zephyr Project is a scalable real-time operating system (RTOS) supporting
17
18
19
20
21
22
23
24
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,
25
Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of
26
27
`supported boards`_.

28
29
30
31
.. below included in doc/introduction/introduction.rst

.. start_include_here

32
33
34
Getting Started
***************

Marti Bolivar's avatar
Marti Bolivar committed
35
36
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
and the documentation's `Getting Started Guide`_ to start developing.
37

38
39
40
Community Support
*****************

Marti Bolivar's avatar
Marti Bolivar committed
41
42
Community support is provided via mailing lists and Slack; see the Resources
below for details.
43

44
45
.. _project-resources:

46
47
48
Resources
*********

Marti Bolivar's avatar
Marti Bolivar committed
49
50
Here's a quick summary of resources to help you find your way around:

51
* **Help**: `Asking for Help Tips`_
Marti Bolivar's avatar
Marti Bolivar committed
52
53
54
55
* **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
56
* **Releases**: https://github.com/zephyrproject-rtos/zephyr/releases
Marti Bolivar's avatar
Marti Bolivar committed
57
58
59
60
61
62
* **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.
63
64
65
* **Nightly CI Build Status**: https://lists.zephyrproject.org/g/builds
  The builds@lists.zephyrproject.org mailing list archives the CI
  (shippable) nightly build results.
Marti Bolivar's avatar
Marti Bolivar committed
66
* **Chat**: Zephyr's Slack workspace is https://zephyrproject.slack.com.  Use
67
  this `Slack Invite`_ to register.
Marti Bolivar's avatar
Marti Bolivar committed
68
69
70
71
72
73
74
* **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
75

76
.. _Slack Invite: https://tinyurl.com/y5glwylp
David B. Kinder's avatar
David B. Kinder committed
77
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
78
.. _Zephyr Documentation: http://docs.zephyrproject.org
Marti Bolivar's avatar
Marti Bolivar committed
79
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
80
81
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
82
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
83
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
84
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
85
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
Marti Bolivar's avatar
Marti Bolivar committed
86
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
87
.. _Asking for Help Tips: https://docs.zephyrproject.org/latest/guides/getting-help.html