David B. Kinder | 2f41cb8 | 2017-05-09 15:38:30 -0700 | [diff] [blame] | 1 | Zephyr Project |
| 2 | ############## |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 3 | |
David B. Kinder | be9f577 | 2017-08-09 14:43:50 -0700 | [diff] [blame] | 4 | .. raw:: html |
| 5 | |
| 6 | <a href="https://bestpractices.coreinfrastructure.org/projects/74"><img |
| 7 | src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a> |
Anas Nashif | 08f9c23 | 2017-10-03 16:25:17 -0400 | [diff] [blame] | 8 | <img |
| 9 | src="https://api.shippable.com/projects/58ffb2b8baa5e307002e1d79/badge?branch=master"> |
| 10 | |
David B. Kinder | be9f577 | 2017-08-09 14:43:50 -0700 | [diff] [blame] | 11 | |
David B. Kinder | 2f41cb8 | 2017-05-09 15:38:30 -0700 | [diff] [blame] | 12 | The Zephyr Project is a scalable real-time operating system (RTOS) supporting |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 13 | multiple hardware architectures, optimized for resource constrained devices, |
| 14 | and built with security in mind. |
| 15 | |
| 16 | The Zephyr OS is based on a small-footprint kernel designed for use on |
| 17 | resource-constrained systems: from simple embedded environmental sensors and |
| 18 | LED wearables to sophisticated smart watches and IoT wireless gateways. |
| 19 | |
| 20 | The Zephyr kernel supports multiple architectures, including ARM Cortex-M, |
David B. Kinder | cf17f48 | 2017-08-18 17:11:15 -0700 | [diff] [blame] | 21 | Intel x86, ARC, NIOS II, Tensilica Xtensa, and RISC V, and a large number of |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 22 | `supported boards`_. |
| 23 | |
David B. Kinder | be9f577 | 2017-08-09 14:43:50 -0700 | [diff] [blame] | 24 | .. below included in doc/introduction/introduction.rst |
| 25 | |
| 26 | .. start_include_here |
| 27 | |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 28 | Community Support |
| 29 | ***************** |
| 30 | |
| 31 | The Zephyr Project Developer Community includes developers from member |
| 32 | organizations and the general community all joining in the development of |
| 33 | software within the Zephyr Project. Members contribute and discuss ideas, |
| 34 | submit bugs and bug fixes, and provide training. They also help those in need |
| 35 | through the community's forums such as mailing lists and IRC channels. Anyone |
| 36 | can join the developer community and the community is always willing to help |
| 37 | its members and the User Community to get the most out of the Zephyr Project. |
| 38 | |
| 39 | Welcome to the Zephyr community! |
| 40 | |
| 41 | Resources |
| 42 | ********* |
| 43 | |
David B. Kinder | 2f41cb8 | 2017-05-09 15:38:30 -0700 | [diff] [blame] | 44 | Here's a quick summary of resources to find your way around the Zephyr Project |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 45 | support systems: |
| 46 | |
| 47 | * **Zephyr Project Website**: The https://zephyrproject.org website is the |
David B. Kinder | 2f41cb8 | 2017-05-09 15:38:30 -0700 | [diff] [blame] | 48 | central source of information about the Zephyr Project. On this site, you'll |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 49 | 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. Kinder | fafff0f | 2017-11-03 15:12:06 -0700 | [diff] [blame] | 54 | https://zephyrproject.org/developers/#downloads. On this page, |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 55 | 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. Kinder | be9f577 | 2017-08-09 14:43:50 -0700 | [diff] [blame] | 63 | contribute to the project in this `Contribution Guide`_ document. |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 64 | |
| 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. Kinder | c5615aa | 2018-05-02 14:25:15 -0700 | [diff] [blame] | 71 | http://docs.zephyrproject.org. Additional documentation is maintained in |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 72 | the `Zephyr GitHub wiki`_. |
| 73 | |
Henrik Brix Andersen | abc47a0 | 2018-03-21 21:45:08 +0100 | [diff] [blame] | 74 | * **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. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 78 | * **Issue Reporting and Tracking**: Requirements and Issue tracking is done in |
Anas Nashif | 37b9ee0 | 2017-10-02 22:33:16 -0400 | [diff] [blame] | 79 | 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. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 81 | |
Andy Gross | a5ae3ea | 2017-10-06 11:51:09 -0500 | [diff] [blame] | 82 | * **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. Kinder | 3b26373 | 2017-08-25 07:52:25 -0700 | [diff] [blame] | 86 | `Security Overview`_. |
| 87 | |
Andy Gross | a5ae3ea | 2017-10-06 11:51:09 -0500 | [diff] [blame] | 88 | Security related issue tracking is done in JIRA. The location of this JIRA |
| 89 | is https://zephyrprojectsec.atlassian.net. |
| 90 | |
David B. Kinder | 0d12b74 | 2018-05-09 14:12:06 -0700 | [diff] [blame] | 91 | * **Mailing List**: The `Zephyr Development mailing list`_ is perhaps the most convenient |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 92 | way to track developer discussions and to ask your own support questions to |
David B. Kinder | 0d12b74 | 2018-05-09 14:12:06 -0700 | [diff] [blame] | 93 | the Zephyr project community. There are also specific `Zephyr mailing list |
| 94 | subgroups`_ for announcements, builds, marketing, and Technical |
David B. Kinder | 6c6cf23 | 2018-05-23 11:35:59 -0700 | [diff] [blame] | 95 | Steering Committee notes, for example. |
David B. Kinder | 0d12b74 | 2018-05-09 14:12:06 -0700 | [diff] [blame] | 96 | You can read through the message archives to follow |
David B. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 97 | 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. Kinder | c5615aa | 2018-05-02 14:25:15 -0700 | [diff] [blame] | 106 | .. _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. Kinder | e7a54dc | 2017-04-29 07:11:05 -0700 | [diff] [blame] | 110 | .. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki |
David B. Kinder | 0d12b74 | 2018-05-09 14:12:06 -0700 | [diff] [blame] | 111 | .. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel |
David B. Kinder | a380dce | 2018-04-16 10:04:28 -0700 | [diff] [blame] | 112 | .. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups |
David B. Kinder | c5615aa | 2018-05-02 14:25:15 -0700 | [diff] [blame] | 113 | .. _Sample and Demo Code Examples: http://docs.zephyrproject.org/samples/samples.html |
| 114 | .. _Security Overview: http://docs.zephyrproject.org/security/security-overview.html |