Skip to content

Commit 8b147cd

Browse files
mbolivar-nordicnashif
authored andcommitted
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 <[email protected]>
1 parent 95a5f90 commit 8b147cd

File tree

1 file changed

+31
-80
lines changed

1 file changed

+31
-80
lines changed

README.rst

Lines changed: 31 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -32,102 +32,53 @@ Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and a large number of
3232
Getting Started
3333
***************
3434

35-
To start developing Zephyr applications refer to the `Getting Started Guide`_
36-
in the `Zephyr Documentation`_ pages.
37-
A brief introduction to Zephyr can be found in the `Zephyr Introduction`_
38-
page.
35+
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
36+
and the documentation's `Getting Started Guide`_ to start developing.
3937

4038
Community Support
4139
*****************
4240

43-
The Zephyr Project Developer Community includes developers from member
44-
organizations and the general community all joining in the development of
45-
software within the Zephyr Project. Members contribute and discuss ideas,
46-
submit bugs and bug fixes, and provide training. They also help those in need
47-
through the community's forums such as mailing lists and IRC channels. Anyone
48-
can join the developer community and the community is always willing to help
49-
its members and the User Community to get the most out of the Zephyr Project.
41+
.. TODO: add link to Asking for Help doc here when the latest page has it
5042
51-
Welcome to the Zephyr community!
43+
Community support is provided via mailing lists and Slack; see the Resources
44+
below for details.
5245

5346
Resources
5447
*********
5548

56-
Here's a quick summary of resources to find your way around the Zephyr Project
57-
support systems:
58-
59-
* **Zephyr Project Website**: The https://zephyrproject.org website is the
60-
central source of information about the Zephyr Project. On this site, you'll
61-
find background and current information about the project as well as all the
62-
relevant links to project material.
63-
64-
* **Releases**: Source code for Zephyr kernel releases are available at
65-
https://zephyrproject.org/developers/#downloads. On this page,
66-
you'll find release information, and links to download or clone source
67-
code from our GitHub repository. You'll also find links for the Zephyr
68-
SDK, a moderated collection of tools and libraries used to develop your
69-
applications.
70-
71-
* **Source Code in GitHub**: Zephyr Project source code is maintained on a
72-
public GitHub repository at https://github.com/zephyrproject-rtos/zephyr.
73-
You'll find information about getting access to the repository and how to
74-
contribute to the project in this `Contribution Guide`_ document.
75-
76-
* **Samples Code**: In addition to the kernel source code, there are also
77-
many documented `Sample and Demo Code Examples`_ that can help show you
78-
how to use Zephyr services and subsystems.
79-
80-
* **Documentation**: Extensive Project technical documentation is developed
81-
along with the Zephyr kernel itself, and can be found at
82-
http://docs.zephyrproject.org. Additional documentation is maintained in
83-
the `Zephyr GitHub wiki`_.
84-
85-
* **Cross-reference**: Source code cross-reference for the Zephyr
86-
kernel and samples code is available at
87-
https://elixir.bootlin.com/zephyr/latest/source.
88-
89-
* **Issue Reporting and Tracking**: Requirements and Issue tracking is done in
90-
the Github issues system: https://github.com/zephyrproject-rtos/zephyr/issues.
91-
You can browse through the reported issues and submit issues of your own.
92-
93-
* **Security-related Issue Reporting and Tracking**: For security-related
94-
inquiries or reporting suspected security-related bugs in the Zephyr OS,
95-
please send email to [email protected]. We will assess and
96-
fix flaws according to our security policy outlined in the Zephyr Project
97-
`Security Overview`_.
98-
99-
Security related issue tracking is done in JIRA. The location of this JIRA
100-
is https://zephyrprojectsec.atlassian.net.
101-
102-
* **Mailing List**: The `Zephyr Development mailing list`_ is perhaps the most convenient
103-
way to track developer discussions and to ask your own support questions to
104-
the Zephyr project community. There are also specific `Zephyr mailing list
105-
subgroups`_ for announcements, builds, marketing, and Technical
106-
Steering Committee notes, for example.
107-
You can read through the message archives to follow
108-
past posts and discussions, a good thing to do to discover more about the
109-
Zephyr project.
110-
111-
* **Chatting**: You can chat online with the Zephyr project developer
112-
community and other users in two ways:
113-
114-
* On `Slack`_: Zephyr has dedicated channels on Slack. To register, use the
115-
following `Slack Invite`_.
116-
117-
* IRC channel #zephyrproject on the freenode.net IRC server. You can use the
118-
http://webchat.freenode.net web client or use a client-side application such
119-
as pidgin (Note that all discussions have moved to Slack, although we still
120-
have many developers still available on the IRC channel).
49+
Here's a quick summary of resources to help you find your way around:
50+
51+
* **Documentation**: http://docs.zephyrproject.org (`Getting Started Guide`_)
52+
* **Source Code**: https://github.com/zephyrproject-rtos/zephyr is the main
53+
repository; https://elixir.bootlin.com/zephyr/latest/source contains a
54+
searchable index
55+
* **Releases**: https://zephyrproject.org/developers/#downloads.
56+
* **Samples and example code**: see `Sample and Demo Code Examples`_
57+
* **Mailing Lists**: [email protected] and
58+
[email protected] are the main user and developer mailing lists,
59+
respectively. You can join the developer's list and search its archives at
60+
`Zephyr Development mailing list`_. The other `Zephyr mailing list
61+
subgroups`_ have their own archives and sign-up pages.
62+
* **Chat**: Zephyr's Slack workspace is https://zephyrproject.slack.com. Use
63+
this `Slack Invite`_ to register. There is also an IRC channel,
64+
``#zephyrproject``, on `freenode`_.
65+
* **Contributing**: see the `Contribution Guide`_
66+
* **Wiki**: `Zephyr GitHub wiki`_
67+
* **Issues**: https://github.com/zephyrproject-rtos/zephyr/issues
68+
* **Security Issues**: Email [email protected] to report
69+
security issues; also see our `Security`_ documentation. Security issues are
70+
tracked separately at https://zephyrprojectsec.atlassian.net.
71+
* **Zephyr Project Website**: https://zephyrproject.org
12172

12273
.. _Slack Invite: https://tinyurl.com/yarkuemx
123-
.. _Slack: https://zephyrproject.slack.com
12474
.. _supported boards: http://docs.zephyrproject.org/latest/boards
12575
.. _Zephyr Documentation: http://docs.zephyrproject.org
126-
.. _Zephyr Introduction: http://docs.zephyrproject.org/latest/introduction/index.html
76+
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
12777
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html
12878
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
12979
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
13080
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
13181
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
13282
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
133-
.. _Security Overview: http://docs.zephyrproject.org/latest/security/index.html
83+
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
84+
.. _freenode: https://freenode.net/

0 commit comments

Comments
 (0)