OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/README.rst

89 lines
4.0 KiB
ReStructuredText
Raw Normal View History

doc: add CII badge, include README in intro LF is requesting a Core Infrastructure Initiative evaluation and badge on our website. This PR introduces that into our README.rst on GitHub and also merges content from the README into our introduction document. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-10 05:43:50 +08:00
.. raw:: html
doc: Replace title with logo in front page Replace the current title with an image containing the Zephyr logo for the root README.rst, in order to make the GitHub landing page more attractive. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-01 19:35:53 +08:00
<a href="https://www.zephyrproject.org">
<p align="center">
readme: make README logo dark-mode aware Use an SVG based logo with embedded style that toggles title color using media queries. The SVG logo is not exactly the same as the previous one as I only had this version in SVG (taken from docs actually). Note that we cannot use the method described in https://github.blog/changelog/ 2021-11-24-specify-theme-context-for-images-in-markdown/ because the README is written in rst, not Markdown. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-16 01:43:53 +08:00
<img src="doc/_static/images/logo-readme.svg">
doc: Replace title with logo in front page Replace the current title with an image containing the Zephyr logo for the root README.rst, in order to make the GitHub landing page more attractive. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-01 19:35:53 +08:00
</p>
</a>
doc: add CII badge, include README in intro LF is requesting a Core Infrastructure Initiative evaluation and badge on our website. This PR introduces that into our README.rst on GitHub and also merges content from the README into our introduction document. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-10 05:43:50 +08:00
<a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
doc: replace buildkite with github actions Update CI docs and the badge with links pointing to GH actions rather than buildkite. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-11-24 04:19:52 +08:00
<a
href="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain">
doc: add ci build status of master Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-04 04:25:17 +08:00
<img
doc: replace buildkite with github actions Update CI docs and the badge with links pointing to GH actions rather than buildkite. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-11-24 04:19:52 +08:00
src="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml/badge.svg?event=push"></a>
doc: add ci build status of master Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-04 04:25:17 +08:00
doc: add CII badge, include README in intro LF is requesting a Core Infrastructure Initiative evaluation and badge on our website. This PR introduces that into our README.rst on GitHub and also merges content from the README into our introduction document. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-10 05:43:50 +08:00
doc: misspelling and UTF-8 fixes More general spelling fixes, and cleaning up stray UTF-8 characters such as curly-quotes, em- and en-dashes. Use replacement strings for |reg| and |trade|. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-05-10 06:38:30 +08:00
The Zephyr Project is a scalable real-time operating system (RTOS) supporting
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
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.
doc: update architectures in README Add all missing architectures to the README. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-05-05 23:33:51 +08:00
The Zephyr kernel supports multiple architectures, including ARM (Cortex-A,
Cortex-R, Cortex-M), Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V,
SPARC, MIPS, and a large number of `supported boards`_.
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
doc: add CII badge, include README in intro LF is requesting a Core Infrastructure Initiative evaluation and badge on our website. This PR introduces that into our README.rst on GitHub and also merges content from the README into our introduction document. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-08-10 05:43:50 +08:00
.. below included in doc/introduction/introduction.rst
doc: Add getting started to README.rst Add a Getting Started section in the README.rst for quick and easy access to what is arguably the most read page of our doc website. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:15:07 +08:00
Getting Started
***************
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>
2019-04-18 02:53:45 +08:00
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
and the documentation's `Getting Started Guide`_ to start developing.
doc: Add getting started to README.rst Add a Getting Started section in the README.rst for quick and easy access to what is arguably the most read page of our doc website. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:15:07 +08:00
doc: start include README after 'getting started' Otherwise we end up with a self-reference to the same page we are in. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-07-03 21:05:06 +08:00
.. start_include_here
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
Community Support
*****************
doc: Document the switch from Slack to Discord After the Technical Steering Committee decided to approve the transition from Slack to Discord, it is necessary to update all the documentation to reflect this change. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2021-09-01 20:33:01 +08:00
Community support is provided via mailing lists and Discord; see the Resources
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>
2019-04-18 02:53:45 +08:00
below for details.
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
doc: New developer getting started guide As presented to the TSC, Zephyr's out-of-box experience for new developers is, well, complicated. A number of suggestions were presented including simplifying the getting started material to present a straight-forward path through the setup and installation steps through to getting a sample application built, flashed, and running. This PR is a work-in-progress towards addressing this OOB experience with a minimal-distractions version of the GSG. Alternatives, warnings, and material that could lead the developer astray were moved to alternative/advanced instruction documents (based on the previous separate Linux/macOS/Windows setup guides) and a new "Beyond the GSG" document. We do take advantage of a sphinx-tabs extension for synchronized tabs to present OS-specific instructions: clicking on one tab will display all same-named tabs throughout the doc. We hope (and will continue evaluating) that this new GSG gets developers set up quickly and then we can send them along to other documents to continue learning about Zephyr and trying other sample apps. Thanks for all your previous feedback that I've worked into this new version. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-09-13 05:32:29 +08:00
.. _project-resources:
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
Resources
*********
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>
2019-04-18 02:53:45 +08:00
Here's a quick summary of resources to help you find your way around:
doc: add references to builds mailing list builds@lists.zephyrproject.org archives the CI build results for every and nightly build. Add references to this in the contribution guidelines and introduction (pulled from README). Also added a reference to the "Asking for Help" doc (there was a note to add this once that doc was merged). Fixes: #15652 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-25 01:34:16 +08:00
* **Help**: `Asking for Help Tips`_
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>
2019-04-18 02:53:45 +08:00
* **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
doc: fix broken links in README and board docs Point to zephyr/sdk release pages instead of non-existent downloads page on project website. Fixes #21706 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-03-13 03:41:57 +08:00
* **Releases**: https://github.com/zephyrproject-rtos/zephyr/releases
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>
2019-04-18 02:53:45 +08:00
* **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.
doc: add references to builds mailing list builds@lists.zephyrproject.org archives the CI build results for every and nightly build. Add references to this in the contribution guidelines and introduction (pulled from README). Also added a reference to the "Asking for Help" doc (there was a note to add this once that doc was merged). Fixes: #15652 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-25 01:34:16 +08:00
* **Nightly CI Build Status**: https://lists.zephyrproject.org/g/builds
doc: replace buildkite with github actions Update CI docs and the badge with links pointing to GH actions rather than buildkite. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-11-24 04:19:52 +08:00
The builds@lists.zephyrproject.org mailing list archives the CI nightly build results.
doc: Document the switch from Slack to Discord After the Technical Steering Committee decided to approve the transition from Slack to Discord, it is necessary to update all the documentation to reflect this change. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2021-09-01 20:33:01 +08:00
* **Chat**: Real-time chat happens in Zephyr's Discord Server. Use
this `Discord Invite`_ to register.
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>
2019-04-18 02:53:45 +08:00
* **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
doc: document slack channel in the main README.rst Add a link to the slack channel and updated IRC info. Fixes #11592 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-12-09 05:28:08 +08:00
doc: Document the switch from Slack to Discord After the Technical Steering Committee decided to approve the transition from Slack to Discord, it is necessary to update all the documentation to reflect this change. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2021-09-01 20:33:01 +08:00
.. _Discord Invite: https://chat.zephyrproject.org
doc: fix broken doc links The project's README.rst references the support board docs with an URL that's not working these days (see https://github.com/zephyrproject-rtos/infrastructure/issues/134) so fix that URL reference. While looking for other similar linking cases, I found a hard URL references that should be using :ref: role, and a release notes reference to a (now) broken link (fixing that in the /latest/ version of the 1.10 release notes). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-31 05:06:14 +08:00
.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html
doc: Add getting started to README.rst Add a Getting Started section in the README.rst for quick and easy access to what is arguably the most read page of our doc website. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-08-02 18:15:07 +08:00
.. _Zephyr Documentation: http://docs.zephyrproject.org
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>
2019-04-18 02:53:45 +08:00
.. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html
readme: Update stale documentation links This commit updates the references to the documentation pages that were relocated in the PR #41154. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-05 23:36:50 +08:00
.. _Getting Started Guide: http://docs.zephyrproject.org/latest/develop/getting_started/index.html
doc: Fix links to docs.zephyrproject.org append /index.html, and now browser loads page with CSS. Signed-off-by: Ivan kyb Kuvaldin <i.kyb@ya.ru>
2019-02-17 06:29:31 +08:00
.. _Contribution Guide: http://docs.zephyrproject.org/latest/contribute/index.html
doc: Add README.rst to project root Jira: ZEP-2055 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-29 22:11:05 +08:00
.. _Zephyr GitHub wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
doc: fix references to mailing lists The mailing list hosting software change introduced some changes to where mailing lists are hosted. Update the docs to point at the specific sublists rather than the top-level site. (See issue #7437). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-10 05:12:06 +08:00
.. _Zephyr Development mailing list: https://lists.zephyrproject.org/g/devel
doc: fix links to mailing lists A recent LF change to the Zephyr mailing list hosting software changed the mailing list names and links to the message archives. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-04-17 01:04:28 +08:00
.. _Zephyr mailing list subgroups: https://lists.zephyrproject.org/g/main/subgroups
doc: Fix links to docs.zephyrproject.org append /index.html, and now browser loads page with CSS. Signed-off-by: Ivan kyb Kuvaldin <i.kyb@ya.ru>
2019-02-17 06:29:31 +08:00
.. _Sample and Demo Code Examples: http://docs.zephyrproject.org/latest/samples/index.html
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>
2019-04-18 02:53:45 +08:00
.. _Security: http://docs.zephyrproject.org/latest/security/index.html
readme: Update stale documentation links This commit updates the references to the documentation pages that were relocated in the PR #41154. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-05 23:36:50 +08:00
.. _Asking for Help Tips: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help