README.rst: shorten it
This is a bit wordy. Let's let the bold text and links stand on their own; anybody looking at a README on GitHub or in technical documentation probably knows what these things mean. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar
Anas Nashif
parent
95a5f90ce7
commit
8b147cd1b9
109
README.rst
109
README.rst
|
|
@ -32,102 +32,53 @@ Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of
|
|||
Getting Started
|
||||
***************
|
||||
|
||||
To start developing Zephyr applications refer to the `Getting Started Guide`_
|
||||
in the `Zephyr Documentation`_ pages.
|
||||
A brief introduction to Zephyr can be found in the `Zephyr Introduction`_
|
||||
page.
|
||||
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
|
||||
and the documentation's `Getting Started Guide`_ to start developing.
|
||||
|
||||
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.
|
||||
.. TODO: add link to Asking for Help doc here when the latest page has it
|
||||
|
||||
Welcome to the Zephyr community!
|
||||
Community support is provided via mailing lists and Slack; see the Resources
|
||||
below for details.
|
||||
|
||||
Resources
|
||||
*********
|
||||
|
||||
Here's a quick summary of resources to find your way around the Zephyr Project
|
||||
support systems:
|
||||
Here's a quick summary of resources to help you find your way around:
|
||||
|
||||
* **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.
|
||||
|
||||
* **Releases**: Source code for Zephyr kernel releases are available at
|
||||
https://zephyrproject.org/developers/#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`_ document.
|
||||
|
||||
* **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
|
||||
http://docs.zephyrproject.org. Additional documentation is maintained in
|
||||
the `Zephyr GitHub wiki`_.
|
||||
|
||||
* **Cross-reference**: Source code cross-reference for the Zephyr
|
||||
kernel and samples code is available at
|
||||
https://elixir.bootlin.com/zephyr/latest/source.
|
||||
|
||||
* **Issue Reporting and Tracking**: Requirements and Issue tracking is done in
|
||||
the Github issues system: https://github.com/zephyrproject-rtos/zephyr/issues.
|
||||
You can browse through the reported issues and submit issues of your own.
|
||||
|
||||
* **Security-related Issue Reporting and Tracking**: For security-related
|
||||
inquiries or reporting suspected security-related bugs in the Zephyr OS,
|
||||
please send email to vulnerabilities@zephyrproject.org. We will assess and
|
||||
fix flaws according to our security policy outlined in the Zephyr Project
|
||||
`Security Overview`_.
|
||||
|
||||
Security related issue tracking is done in JIRA. The location of this JIRA
|
||||
is https://zephyrprojectsec.atlassian.net.
|
||||
|
||||
* **Mailing List**: The `Zephyr Development mailing list`_ is perhaps the most convenient
|
||||
way to track developer discussions and to ask your own support questions to
|
||||
the Zephyr project community. There are also specific `Zephyr mailing list
|
||||
subgroups`_ for announcements, builds, marketing, and Technical
|
||||
Steering Committee notes, for example.
|
||||
You can read through the message archives to follow
|
||||
past posts and discussions, a good thing to do to discover more about the
|
||||
Zephyr project.
|
||||
|
||||
* **Chatting**: You can chat online with the Zephyr project developer
|
||||
community and other users in two ways:
|
||||
|
||||
* On `Slack`_: Zephyr has dedicated channels on Slack. To register, use the
|
||||
following `Slack Invite`_.
|
||||
|
||||
* 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 (Note that all discussions have moved to Slack, although we still
|
||||
have many developers still available on the IRC channel).
|
||||
* **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
|
||||
* **Releases**: https://zephyrproject.org/developers/#downloads.
|
||||
* **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.
|
||||
* **Chat**: Zephyr's Slack workspace is https://zephyrproject.slack.com. Use
|
||||
this `Slack Invite`_ to register. There is also an IRC channel,
|
||||
``#zephyrproject``, on `freenode`_.
|
||||
* **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
|
||||
|
||||
.. _Slack Invite: https://tinyurl.com/yarkuemx
|
||||
.. _Slack: https://zephyrproject.slack.com
|
||||
.. _supported boards: http://docs.zephyrproject.org/latest/boards
|
||||
.. _Zephyr Documentation: http://docs.zephyrproject.org
|
||||
.. _Zephyr Introduction: http://docs.zephyrproject.org/latest/introduction/index.html
|
||||
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
|
||||
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html
|
||||
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
|
||||
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
|
||||
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
|
||||
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
|
||||
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
|
||||
.. _Security Overview: http://docs.zephyrproject.org/latest/security/index.html
|
||||
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
|
||||
.. _freenode: https://freenode.net/
|
||||
|
|
|
|||
Loading…
Reference in a new issue