Skip to content

Commit 30fef83

Browse files
AnnsAnnsAnnsAnns
committed
README.md: Unify formatting, modernize badges & update URLs
1 parent 142dbf9 commit 30fef83

File tree

1 file changed

+124
-113
lines changed

1 file changed

+124
-113
lines changed

‎README.md‎

Lines changed: 124 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
[![Nightly CI status master][master-ci-badge]][master-ci-link]
1+
[![Nightly CI status master][ci-badge]][ci-link]
22
[![GitHub release][release-badge]][release-link]
33
[![License][license-badge]][license-link]
44
[![API docs][api-badge]][api-link]
5-
[![Wiki][wiki-badge]][wiki-link]
6-
[![Stack Overflow questions][stackoverflow-badge]][stackoverflow-link]
5+
[![Getting Started Guide][guide-badge]][guide-link]
76
[![Mastodon][mastodon-badge]][mastodon-link]
87
[![Matrix][matrix-badge]][matrix-link]
98

@@ -34,114 +33,125 @@
3433
ZZZZZZZZZZZ Z
3534
ZZZZZ --></p>
3635

37-
The friendly Operating System for IoT!
36+
# RIOT OS: The friendly Operating System for IoT!
3837

39-
RIOT is an open-source microcontroller operating system, designed to match
38+
RIOT is an **open-source microcontroller operating system**, designed to match
4039
the requirements of Internet of Things (IoT) devices and other embedded devices.
4140
It supports a range of devices that are typically found in the Internet of Things (IoT):
42-
8-bit, 16-bit and 32-bit microcontrollers.
41+
*8-bit*, *16-bit* and *32-bit* microcontrollers.
4342

44-
RIOT is based on the following design principles: energy-efficiency, real-time
45-
capabilities, small memory footprint, modularity, and uniform API access,
43+
RIOT is based on the following design principles: **energy-efficiency, real-time
44+
capabilities, small memory footprint, modularity, and uniform API access,**
4645
independent of the underlying hardware (this API offers partial POSIX
4746
compliance).
4847

4948
RIOT is developed by an international open source community which is
5049
independent of specific vendors (e.g. similarly to the Linux community).
51-
RIOT is licensed with LGPLv2.1, a copyleft license which fosters
50+
RIOT is licensed with **LGPLv2.1**, a copyleft license which fosters
5251
indirect business models around the free open-source software platform
5352
provided by RIOT, e.g. it is possible to link closed-source code with the
5453
LGPL code.
5554

56-
## Features
57-
58-
RIOT provides features including, but not limited to:
59-
60-
* Platforms Supported
61-
- 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7, and ARM Cortex-M
62-
- The native port allows to run RIOT as-is on Linux and BSD.
63-
Multiple instances of RIOT running on a single machine can also be
64-
interconnected via a simple virtual Ethernet bridge or via a simulated
65-
IEEE 802.15.4 network (ZEP).
66-
67-
* Programming Environment
68-
- Write native code in C, C++, or Rust
69-
- Rely upon POSIX APIs, user friendly hardware abstractions and standard embedded Rust interfaces
70-
- Integrate dynamic runtimes such as MicroPython, elm (JavaScript) and WASM
71-
72-
* Network Features and Protocols
73-
- IPv6
74-
- IPv4 via lwIP
75-
- 6LoWPAN (RFC4944, RFC6282, RFC6775 and RFC7668)
76-
- UDP
77-
- TCP
78-
- RPL (storing mode, P2P mode)
79-
- CoAP
80-
- MQTT via paho-mqtt and MQTT-SN
81-
- LwM2M
82-
- Bluetooth (BLE) via [NimBLE](https://github.com/apache/mynewt-nimble)
83-
- LoRaWAN
84-
- UWB
85-
- CAN
86-
- CNN-Lite
87-
- LwIP
88-
- IEEE 802.15.4
89-
- Ethernet (also via USB)
90-
- SLIP (or ethos networking via Serial)
91-
- Dose (single pair ethernet like networking on serial interface UART)
92-
93-
* System Features
94-
- a preemptive, tickless scheduler with priorities, optional periodic round robin within priorities
95-
- flexible memory management
96-
- high resolution, long-term timers
97-
- MTD abstraction layer for memory devices
98-
- File System integration
99-
100-
* Security Features
101-
- OTA updates via SUIT
102-
- PSA Cryptographic API
103-
- DTLS, EDHOC
104-
105-
* Device Drivers
106-
- SPI, I2C, UART, USB, CAN
107-
- RTC, PWM, Timer
108-
- ADC, DAC
109-
- Various sensors: Environmental sensors, IMUs, magnetometers, particulate matter sensors
110-
- Various actuators: Servos, motors, dimmers, switches, RGB LEDs
111-
- Displays and touchscreens
112-
- GNSS
55+
[ci-badge]: https://ci.riot-os.org/job/branch/master/badge
56+
[ci-link]: https://ci.riot-os.org/details/branch/master
57+
[release-badge]: https://img.shields.io/github/release/RIOT-OS/RIOT.svg
58+
[release-link]: https://github.com/RIOT-OS/RIOT/releases/latest
59+
[license-badge]: https://img.shields.io/github/license/RIOT-OS/RIOT
60+
[license-link]: https://github.com/RIOT-OS/RIOT/blob/master/LICENSE
61+
[api-badge]: https://img.shields.io/badge/docs-API-informational.svg
62+
[api-link]: https://doc.riot-os.org/
63+
[guide-badge]: https://img.shields.io/badge/docs-Getting_Started_Guide-informational.svg
64+
[guide-link]: https://guide.riot-os.org/getting-started/installing/
65+
[mastodon-badge]: https://img.shields.io/badge/social-Mastodon-informational.svg
66+
[mastodon-link]: https://floss.social/@RIOT_OS
67+
[matrix-badge]: https://img.shields.io/badge/chat-Matrix-brightgreen.svg
68+
[matrix-link]: https://matrix.to/#/#riot-os:matrix.org
11369

11470
## Getting Started
11571

116-
* **Start here:**
117-
Our comprehensive [Getting Started Guide](https://guide.riot-os.org/getting-started/installing/)
72+
- **Start here:**
73+
Our comprehensive [Getting Started Guide][getting-started]
11874
walks you through installation and your first RIOT applications.
75+
- **Learn by doing:**
76+
- Try our [hands-on tutorials][tutorials] designed for beginners
77+
- Take the [RIOT online course][riot-course] at your own pace
78+
- **Explore the API:** Check out the [API documentation][api-docs]
79+
for detailed information on RIOT's features and functions.
11980

120-
* **Learn by doing:**
121-
* Try our [hands-on tutorials](https://github.com/RIOT-OS/Tutorials) designed for beginners
122-
* Take the [RIOT online course](https://github.com/RIOT-OS/riot-course) at your own pace
81+
[getting-started]: https://guide.riot-os.org/getting-started/installing/
82+
[tutorials]: https://github.com/RIOT-OS/Tutorials
83+
[riot-course]: https://github.com/RIOT-OS/riot-course
84+
[api-docs]: https://doc.riot-os.org/
12385

124-
* **Explore the API:** Check out the [API documentation](https://doc.riot-os.org/)
125-
for detailed information on RIOT's features and functions.
86+
## Features
87+
88+
RIOT provides features including, but not limited to:
89+
- Platforms Supported
90+
- 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7, and ARM Cortex-M
91+
- The native port allows to run RIOT as-is on Linux and BSD.
92+
Multiple instances of RIOT running on a single machine can also be
93+
interconnected via a simple virtual Ethernet bridge or via a simulated
94+
IEEE 802.15.4 network (ZEP).
95+
- Programming Environment
96+
- Write native code in C, C++, or Rust
97+
- Rely upon POSIX APIs, user friendly hardware abstractions and standard embedded Rust interfaces
98+
- Integrate dynamic runtimes such as MicroPython, elm (JavaScript) and WASM
99+
- Network Features and Protocols
100+
- IPv6
101+
- IPv4 via lwIP
102+
- 6LoWPAN (RFC4944, RFC6282, RFC6775 and RFC7668)
103+
- UDP
104+
- TCP
105+
- RPL (storing mode, P2P mode)
106+
- CoAP
107+
- MQTT via paho-mqtt and MQTT-SN
108+
- LwM2M
109+
- Bluetooth (BLE) via [NimBLE][nimble]
110+
- LoRaWAN
111+
- UWB
112+
- CAN
113+
- CNN-Lite
114+
- LwIP
115+
- IEEE 802.15.4
116+
- Ethernet (also via USB)
117+
- SLIP (or ethos networking via Serial)
118+
- Dose (single pair ethernet like networking on serial interface UART)
119+
- System Features
120+
- a preemptive, tickless scheduler with priorities, optional periodic round robin within priorities
121+
- flexible memory management
122+
- high resolution, long-term timers
123+
- MTD abstraction layer for memory devices
124+
- File System integration
125+
- Security Features
126+
- OTA updates via SUIT
127+
- PSA Cryptographic API
128+
- DTLS, EDHOC
129+
- Device Drivers
130+
- SPI, I2C, UART, USB, CAN
131+
- RTC, PWM, Timer
132+
- ADC, DAC
133+
- Various sensors: Environmental sensors, IMUs, magnetometers, particulate matter sensors
134+
- Various actuators: Servos, motors, dimmers, switches, RGB LEDs
135+
- Displays and touchscreens
136+
- GNSS
137+
138+
[nimble]: https://github.com/apache/mynewt-nimble
126139

127140
## Community
128141

129142
You can ask for help on the Forum or on Matrix. Please send bug reports and
130-
feature requests to our [GitHub issue tracker](https://github.com/RIOT-OS/RIOT/issues)
143+
feature requests to our [GitHub issue tracker][issues]
131144

132-
- [forum](https://forum.riot-os.org) is the default place to start asking for
133-
help. Our Forum provides an archive of prior questions and answers.
145+
- The [Forum][forum] is the default place to start asking for
146+
help. Our Forum provides an archive of prior questions and answers.
134147
- For chat, we use
135-
[#riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org) on the
136-
[Matrix](https://matrix.org/) chat network.
137-
- [GitHub Issue tracker](https://github.com/RIOT-OS/RIOT/issues) for issues
138-
with the code and documentation.
148+
[#riot-os:matrix.org][matrix-chat] on the
149+
[Matrix][matrix] chat network.
139150

140151
### Governance
141152

142-
For how our community is structured and governed, please see our [governance document].
143-
144-
[governance document]: GOVERNANCE.md
153+
For how our community is structured and governed,
154+
please see our [governance document][governance].
145155

146156
### How to Ask
147157

@@ -154,7 +164,18 @@ only "this isn't working". These details include:
154164

155165
### Collaboration
156166

157-
RIOT closely collaborates with and inspires other open source projects, e.g., [Ariel OS](https://ariel-os.org/), an IoT OS written in Rust. We are more than happy to collaborate with those who share our [vision](https://doc.riot-os.org/vision.html).
167+
RIOT closely collaborates with and inspires other open source projects,
168+
e.g., [Ariel OS][ariel], an IoT OS written in Rust.
169+
We are more than happy to collaborate with those who share our
170+
[vision][vision].
171+
172+
[issues]: https://github.com/RIOT-OS/RIOT/issues
173+
[forum]: https://forum.riot-os.org
174+
[matrix-chat]: https://matrix.to/#/#riot-os:matrix.org
175+
[matrix]: https://matrix.org/
176+
[governance]: https://guide.riot-os.org/general/governance/
177+
[ariel]: https://ariel-os.org/
178+
[vision]: https://guide.riot-os.org/general/vision/
158179

159180
## Getting RIOT
160181

@@ -168,55 +189,45 @@ this will ensure that you get all the newest features and bug fixes with the
168189
caveat of an ever changing work environment.
169190

170191
If you prefer things more stable, you can download the source code of one of our
171-
quarter annual releases [via Github][releases] as ZIP file or tarball. You can
172-
also checkout a release in a cloned Git repository using
192+
quarter annual releases [via Github][releases]
193+
as ZIP file or tarball. You can also checkout a release in
194+
a cloned Git repository using
173195

174196
```console
175197
$ git pull --tags
176198
$ git checkout <YYYY.MM>
177199
```
178200

179-
For more details on our release cycle, check our [documentation][release cycle].
201+
For more details on our release cycle, check our
202+
[documentation][release-cycle].
180203

181204
[releases]: https://github.com/RIOT-OS/RIOT/releases
182-
[release cycle]: https://doc.riot-os.org/release-cycle.html
205+
[release-cycle]: https://guide.riot-os.org/misc/release_cycle/
183206

184207
## Contribute
185208

186209
To contribute something to RIOT, please refer to our
187-
[contributing document](CONTRIBUTING.md).
210+
[contributing document][contributing].
211+
212+
[contributing]: CONTRIBUTING.md
188213

189214
## Mailing Lists
190-
* Github notifications: [[email protected]](https://lists.riot-os.org/mailman/listinfo/notifications)
215+
216+
- Github notifications:
217+
[[email protected]][notifications]
218+
219+
[notifications]: https://lists.riot-os.org/postorius/lists/notifications.lists.riot-os.org/
191220

192221
## License
193-
* Most of the code developed by the RIOT community is licensed under the GNU
222+
223+
- Most of the code developed by the RIOT community is licensed under the GNU
194224
Lesser General Public License (LGPL) version 2.1 as published by the Free
195225
Software Foundation.
196-
* Some external sources, especially files developed by SICS are published under
226+
- Some external sources, especially files developed by SICS are published under
197227
a separate license.
198228

199229
All code files contain licensing information.
200230

201-
For more information, see the RIOT website:
202-
203-
https://www.riot-os.org
231+
For more information, see the [RIOT website][riot-website].
204232

205-
206-
[api-badge]: https://img.shields.io/badge/docs-API-informational.svg
207-
[api-link]: https://doc.riot-os.org/
208-
[license-badge]: https://img.shields.io/github/license/RIOT-OS/RIOT
209-
[license-link]: https://github.com/RIOT-OS/RIOT/blob/master/LICENSE
210-
[master-ci-badge]: https://ci.riot-os.org/job/branch/master/badge
211-
[master-ci-link]: https://ci.riot-os.org/details/branch/master
212-
[matrix-badge]: https://img.shields.io/badge/chat-Matrix-brightgreen.svg
213-
[matrix-link]: https://matrix.to/#/#riot-os:matrix.org
214-
[merge-chance-link]: https://merge-chance.info/target?repo=RIOT-OS/RIOT
215-
[release-badge]: https://img.shields.io/github/release/RIOT-OS/RIOT.svg
216-
[release-link]: https://github.com/RIOT-OS/RIOT/releases/latest
217-
[stackoverflow-badge]: https://img.shields.io/badge/stackoverflow-%5Briot--os%5D-yellow
218-
[stackoverflow-link]: https://stackoverflow.com/questions/tagged/riot-os
219-
[mastodon-badge]: https://img.shields.io/badge/social-Mastodon-informational.svg
220-
[mastodon-link]: https://floss.social/@RIOT_OS
221-
[wiki-badge]: https://img.shields.io/badge/docs-Wiki-informational.svg
222-
[wiki-link]: https://github.com/RIOT-OS/RIOT/wiki
233+
[riot-website]: https://www.riot-os.org

0 commit comments

Comments
 (0)