blob: c9aafe6a146f28aea949458439feebc7a5aaec85 [file] [log] [blame]
David B. Kinder2f41cb82017-05-09 15:38:30 -07001Zephyr Project
2##############
David B. Kindere7a54dc2017-04-29 07:11:05 -07003
David B. Kinderbe9f5772017-08-09 14:43:50 -07004.. raw:: html
5
6 <a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
7 src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
Anas Nashif08f9c232017-10-03 16:25:17 -04008 <img
9 src="https://api.shippable.com/projects/58ffb2b8baa5e307002e1d79/badge?branch=master">
10
David B. Kinderbe9f5772017-08-09 14:43:50 -070011
David B. Kinder2f41cb82017-05-09 15:38:30 -070012The Zephyr Project is a scalable real-time operating system (RTOS) supporting
David B. Kindere7a54dc2017-04-29 07:11:05 -070013multiple hardware architectures, optimized for resource constrained devices,
14and built with security in mind.
15
16The Zephyr OS is based on a small-footprint kernel designed for use on
17resource-constrained systems: from simple embedded environmental sensors and
18LED wearables to sophisticated smart watches and IoT wireless gateways.
19
20The Zephyr kernel supports multiple architectures, including ARM Cortex-M,
David B. Kindercf17f482017-08-18 17:11:15 -070021Intel x86, ARC, NIOS II, Tensilica Xtensa, and RISC V, and a large number of
David B. Kindere7a54dc2017-04-29 07:11:05 -070022`supported boards`_.
23
David B. Kinderbe9f5772017-08-09 14:43:50 -070024.. below included in doc/introduction/introduction.rst
25
26.. start_include_here
27
David B. Kindere7a54dc2017-04-29 07:11:05 -070028Community Support
29*****************
30
31The Zephyr Project Developer Community includes developers from member
32organizations and the general community all joining in the development of
33software within the Zephyr Project. Members contribute and discuss ideas,
34submit bugs and bug fixes, and provide training. They also help those in need
35through the community's forums such as mailing lists and IRC channels. Anyone
36can join the developer community and the community is always willing to help
37its members and the User Community to get the most out of the Zephyr Project.
38
39Welcome to the Zephyr community!
40
41Resources
42*********
43
David B. Kinder2f41cb82017-05-09 15:38:30 -070044Here's a quick summary of resources to find your way around the Zephyr Project
David B. Kindere7a54dc2017-04-29 07:11:05 -070045support systems:
46
47* **Zephyr Project Website**: The https://zephyrproject.org website is the
David B. Kinder2f41cb82017-05-09 15:38:30 -070048 central source of information about the Zephyr Project. On this site, you'll
David B. Kindere7a54dc2017-04-29 07:11:05 -070049 find background and current information about the project as well as all the
50 relevant links to project material. For a quick start, refer to the
51 `Zephyr Introduction`_ and `Getting Started Guide`_.
52
53* **Releases**: Source code for Zephyr kernel releases are available at
David B. Kinderfafff0f2017-11-03 15:12:06 -070054 https://zephyrproject.org/developers/#downloads. On this page,
David B. Kindere7a54dc2017-04-29 07:11:05 -070055 you'll find release information, and links to download or clone source
56 code from our GitHub repository. You'll also find links for the Zephyr
57 SDK, a moderated collection of tools and libraries used to develop your
58 applications.
59
60* **Source Code in GitHub**: Zephyr Project source code is maintained on a
61 public GitHub repository at https://github.com/zephyrproject-rtos/zephyr.
62 You'll find information about getting access to the repository and how to
David B. Kinderbe9f5772017-08-09 14:43:50 -070063 contribute to the project in this `Contribution Guide`_ document.
David B. Kindere7a54dc2017-04-29 07:11:05 -070064
65* **Samples Code**: In addition to the kernel source code, there are also
66 many documented `Sample and Demo Code Examples`_ that can help show you
67 how to use Zephyr services and subsystems.
68
69* **Documentation**: Extensive Project technical documentation is developed
70 along with the Zephyr kernel itself, and can be found at
David B. Kinderc5615aa2018-05-02 14:25:15 -070071 http://docs.zephyrproject.org. Additional documentation is maintained in
David B. Kindere7a54dc2017-04-29 07:11:05 -070072 the `Zephyr GitHub wiki`_.
73
Henrik Brix Andersenabc47a02018-03-21 21:45:08 +010074* **Cross-reference**: Source code cross-reference for the Zephyr
75 kernel and samples code is available at
76 https://elixir.bootlin.com/zephyr/latest/source.
77
David B. Kindere7a54dc2017-04-29 07:11:05 -070078* **Issue Reporting and Tracking**: Requirements and Issue tracking is done in
Anas Nashif37b9ee02017-10-02 22:33:16 -040079 the Github issues system: https://github.com/zephyrproject-rtos/zephyr/issues.
80 You can browse through the reported issues and submit issues of your own.
David B. Kindere7a54dc2017-04-29 07:11:05 -070081
Andy Grossa5ae3ea2017-10-06 11:51:09 -050082* **Security-related Issue Reporting and Tracking**: For security-related
83 inquiries or reporting suspected security-related bugs in the Zephyr OS,
84 please send email to vulnerabilities@zephyrproject.org. We will assess and
85 fix flaws according to our security policy outlined in the Zephyr Project
David B. Kinder3b263732017-08-25 07:52:25 -070086 `Security Overview`_.
87
Andy Grossa5ae3ea2017-10-06 11:51:09 -050088 Security related issue tracking is done in JIRA. The location of this JIRA
89 is https://zephyrprojectsec.atlassian.net.
90
David B. Kinder0d12b742018-05-09 14:12:06 -070091* **Mailing List**: The `Zephyr Development mailing list`_ is perhaps the most convenient
David B. Kindere7a54dc2017-04-29 07:11:05 -070092 way to track developer discussions and to ask your own support questions to
David B. Kinder0d12b742018-05-09 14:12:06 -070093 the Zephyr project community. There are also specific `Zephyr mailing list
94 subgroups`_ for announcements, builds, marketing, and Technical
David B. Kinder6c6cf232018-05-23 11:35:59 -070095 Steering Committee notes, for example.
David B. Kinder0d12b742018-05-09 14:12:06 -070096 You can read through the message archives to follow
David B. Kindere7a54dc2017-04-29 07:11:05 -070097 past posts and discussions, a good thing to do to discover more about the
98 Zephyr project.
99
100* **IRC Chatting**: You can chat online with the Zephyr project developer
101 community and other users in our IRC channel #zephyrproject on the
102 freenode.net IRC server. You can use the http://webchat.freenode.net web
103 client or use a client-side application such as pidgin.
104
105
David B. Kinderc5615aa2018-05-02 14:25:15 -0700106.. _supported boards: http://docs.zephyrproject.org/boards/boards.html
107.. _Zephyr Introduction: http://docs.zephyrproject.org/introduction/introducing_zephyr.html
108.. _Getting Started Guide: http://docs.zephyrproject.org/getting_started/getting_started.html
109.. _Contribution Guide: http://docs.zephyrproject.org/contribute/contribute_guidelines.html
David B. Kindere7a54dc2017-04-29 07:11:05 -0700110.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
David B. Kinder0d12b742018-05-09 14:12:06 -0700111.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
David B. Kindera380dce2018-04-16 10:04:28 -0700112.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
David B. Kinderc5615aa2018-05-02 14:25:15 -0700113.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/samples/samples.html
114.. _Security Overview: http://docs.zephyrproject.org/security/security-overview.html