-
Notifications
You must be signed in to change notification settings - Fork 6.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Add README.rst to project root #17
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
:orphan: | ||
|
||
Zephyr™ Project | ||
############### | ||
|
||
The Zephyr™ Project is a scalable real-time operating system (RTOS) supporting | ||
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, | ||
Intel x86, ARC, NIOS II and RISC V, and a large number of | ||
`supported boards`_. | ||
|
||
Community Support | ||
***************** | ||
|
||
The Zephyr Project Developer Community includes developers from member | ||
organizations and the general community all joining in the development of | ||
software within the Zephyr Project. Members contribute and discuss ideas, | ||
submit bugs and bug fixes, and provide training. They also help those in need | ||
through the community's forums such as mailing lists and IRC channels. Anyone | ||
can join the developer community and the community is always willing to help | ||
its members and the User Community to get the most out of the Zephyr Project. | ||
|
||
Welcome to the Zephyr community! | ||
|
||
Resources | ||
********* | ||
|
||
Here’s a quick summary of resources to find your way around the Zephyr Project | ||
support systems: | ||
|
||
* **Zephyr Project Website**: The https://zephyrproject.org website is the | ||
central source of information about the Zephyr Project. On this site, you’ll | ||
find background and current information about the project as well as all the | ||
relevant links to project material. For a quick start, refer to the | ||
`Zephyr Introduction`_ and `Getting Started Guide`_. | ||
|
||
* **Releases**: Source code for Zephyr kernel releases are available at | ||
https://zephyrproject.org/downloads. On this page, | ||
you'll find release information, and links to download or clone source | ||
code from our GitHub repository. You'll also find links for the Zephyr | ||
SDK, a moderated collection of tools and libraries used to develop your | ||
applications. | ||
|
||
* **Source Code in GitHub**: Zephyr Project source code is maintained on a | ||
public GitHub repository at https://github.com/zephyrproject-rtos/zephyr. | ||
You'll find information about getting access to the repository and how to | ||
contribute to the project in this `Contribution Guide`_ wiki article. | ||
|
||
* **Samples Code**: In addition to the kernel source code, there are also | ||
many documented `Sample and Demo Code Examples`_ that can help show you | ||
how to use Zephyr services and subsystems. | ||
|
||
* **Documentation**: Extensive Project technical documentation is developed | ||
along with the Zephyr kernel itself, and can be found at | ||
https://zephyrproject.org/doc. Additional documentation is maintained in | ||
the `Zephyr GitHub wiki`_. | ||
|
||
* **Issue Reporting and Tracking**: Requirements and Issue tracking is done in | ||
our JIRA system: https://jira.zephyrproject.org. You can browse through the | ||
reported issues and submit issues of your own. | ||
|
||
* **Mailing List**: The `Zephyr Mailing Lists`_ are perhaps the most convenient | ||
way to track developer discussions and to ask your own support questions to | ||
the Zephyr project community. | ||
You can also read through message archives to follow | ||
past posts and discussions, a good thing to do to discover more about the | ||
Zephyr project. | ||
|
||
* **IRC Chatting**: You can chat online with the Zephyr project developer | ||
community and other users in our IRC channel #zephyrproject on the | ||
freenode.net IRC server. You can use the http://webchat.freenode.net web | ||
client or use a client-side application such as pidgin. | ||
|
||
|
||
.. _supported boards: https://www.zephyrproject.org/doc/boards/boards.html | ||
.. _Zephyr Introduction: https://www.zephyrproject.org/doc/introduction/introducing_zephyr.html | ||
.. _Getting Started Guide: https://www.zephyrproject.org/doc/getting_started/getting_started.html | ||
.. _Contribution Guide: https://github.com/zephyrproject-rtos/zephyr/wiki/Contribution-Guide | ||
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki | ||
.. _Zephyr Mailing Lists: https://lists.zephyrproject.org/ | ||
.. _Sample and Demo Code Examples: https://www.zephyrproject.org/doc/samples/samples.html |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this, it appears on the main repo page now.