Merge pull request #21706 from AnnsAnns/guide_readme

README.md: Unify formatting, modernize badges & update URLs (and move release_cycle to starlight)

Author: crasbe

README.md

@@ -1,9 +1,8 @@
-[![Nightly CI status master][master-ci-badge]][master-ci-link]
+[![Nightly CI status master][ci-badge]][ci-link]
 [![GitHub release][release-badge]][release-link]
 [![License][license-badge]][license-link]
 [![API docs][api-badge]][api-link]
-[![Wiki][wiki-badge]][wiki-link]
-[![Stack Overflow questions][stackoverflow-badge]][stackoverflow-link]
+[![Getting Started Guide][guide-badge]][guide-link]
 [![Mastodon][mastodon-badge]][mastodon-link]
 [![Matrix][matrix-badge]][matrix-link]
 
@@ -34,114 +33,125 @@
          ZZZZZZZZZZZ               Z
             ZZZZZ                                                           --></p>
 
-The friendly Operating System for IoT!
+# RIOT OS: The friendly Operating System for IoT!
 
-RIOT is an open-source microcontroller operating system, designed to match
+RIOT is an **open-source microcontroller operating system**, designed to match
 the requirements of Internet of Things (IoT) devices and other embedded devices.
 It supports a range of devices that are typically found in the Internet of Things (IoT):
-8-bit, 16-bit and 32-bit microcontrollers.
+*8-bit*, *16-bit* and *32-bit* microcontrollers.
 
-RIOT is based on the following design principles: energy-efficiency, real-time
-capabilities, small memory footprint, modularity, and uniform API access,
+RIOT is based on the following design principles: **energy-efficiency, real-time
+capabilities, small memory footprint, modularity, and uniform API access,**
 independent of the underlying hardware (this API offers partial POSIX
 compliance).
 
 RIOT is developed by an international open source community which is
 independent of specific vendors (e.g. similarly to the Linux community).
-RIOT is licensed with LGPLv2.1, a copyleft license which fosters
+RIOT is licensed with **LGPLv2.1**, a copyleft license which fosters
 indirect business models around the free open-source software platform
 provided by RIOT, e.g. it is possible to link closed-source code with the
 LGPL code.
 
-## Features
-
-RIOT provides features including, but not limited to:
-
- * Platforms Supported
-    - 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7, and ARM Cortex-M
-    - The native port allows to run RIOT as-is on Linux and BSD.
-      Multiple instances of RIOT running on a single machine can also be
-      interconnected via a simple virtual Ethernet bridge or via a simulated
-      IEEE 802.15.4 network (ZEP).
-
- * Programming Environment
-    - Write native code in C, C++, or Rust
-    - Rely upon POSIX APIs, user friendly hardware abstractions and standard embedded Rust interfaces
-    - Integrate dynamic runtimes such as MicroPython, elm (JavaScript) and WASM
-
- * Network Features and Protocols
-    - IPv6
-    - IPv4 via lwIP
-    - 6LoWPAN (RFC4944, RFC6282, RFC6775 and RFC7668)
-    - UDP
-    - TCP
-    - RPL (storing mode, P2P mode)
-    - CoAP
-    - MQTT via paho-mqtt and MQTT-SN
-    - LwM2M
-    - Bluetooth (BLE) via [NimBLE](https://github.com/apache/mynewt-nimble)
-    - LoRaWAN
-    - UWB
-    - CAN
-    - CNN-Lite
-    - LwIP
-    - IEEE 802.15.4
-    - Ethernet (also via USB)
-    - SLIP (or ethos networking via Serial)
-    - Dose (single pair ethernet like networking on serial interface UART)
-
- * System Features
-    - a preemptive, tickless scheduler with priorities, optional periodic round robin within priorities
-    - flexible memory management
-    - high resolution, long-term timers
-    - MTD abstraction layer for memory devices
-    - File System integration
-
- * Security Features
-    - OTA updates via SUIT
-    - PSA Cryptographic API
-    - DTLS, EDHOC
-
- * Device Drivers
-    - SPI, I2C, UART, USB, CAN
-    - RTC, PWM, Timer
-    - ADC, DAC
-    - Various sensors: Environmental sensors, IMUs, magnetometers, particulate matter sensors
-    - Various actuators: Servos, motors, dimmers, switches, RGB LEDs
-    - Displays and touchscreens
-    - GNSS
+[ci-badge]: https://ci.riot-os.org/job/branch/master/badge
+[ci-link]: https://ci.riot-os.org/details/branch/master
+[release-badge]: https://img.shields.io/github/release/RIOT-OS/RIOT.svg
+[release-link]: https://github.com/RIOT-OS/RIOT/releases/latest
+[license-badge]: https://img.shields.io/github/license/RIOT-OS/RIOT
+[license-link]: https://github.com/RIOT-OS/RIOT/blob/master/LICENSE
+[api-badge]: https://img.shields.io/badge/docs-API-informational.svg
+[api-link]: https://doc.riot-os.org/
+[guide-badge]: https://img.shields.io/badge/docs-Getting_Started_Guide-informational.svg
+[guide-link]: https://guide.riot-os.org/getting-started/installing/
+[mastodon-badge]: https://img.shields.io/badge/social-Mastodon-informational.svg
+[mastodon-link]: https://floss.social/@RIOT_OS
+[matrix-badge]: https://img.shields.io/badge/chat-Matrix-brightgreen.svg
+[matrix-link]: https://matrix.to/#/#riot-os:matrix.org
 
 ## Getting Started
 
-* **Start here:**
-  Our comprehensive [Getting Started Guide](https://guide.riot-os.org/getting-started/installing/)
+- **Start here:**
+  Our comprehensive [Getting Started Guide][getting-started]
   walks you through installation and your first RIOT applications.
+- **Learn by doing:**
+  - Try our [hands-on tutorials][tutorials] designed for beginners
+  - Take the [RIOT online course][riot-course] at your own pace
+- **Explore the API:** Check out the [API documentation][api-docs]
+  for detailed information on RIOT's features and functions.
 
-* **Learn by doing:**
-    * Try our [hands-on tutorials](https://github.com/RIOT-OS/Tutorials) designed for beginners
-    * Take the [RIOT online course](https://github.com/RIOT-OS/riot-course) at your own pace
+[getting-started]: https://guide.riot-os.org/getting-started/installing/
+[tutorials]: https://github.com/RIOT-OS/Tutorials
+[riot-course]: https://github.com/RIOT-OS/riot-course
+[api-docs]: https://doc.riot-os.org/
 
-* **Explore the API:** Check out the [API documentation](https://doc.riot-os.org/)
-  for detailed information on RIOT's features and functions.
+## Features
+
+RIOT provides features including, but not limited to:
+- Platforms Supported
+  - 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7, and ARM Cortex-M
+  - The native port allows to run RIOT as-is on Linux and BSD.
+    Multiple instances of RIOT running on a single machine can also be
+    interconnected via a simple virtual Ethernet bridge or via a simulated
+    IEEE 802.15.4 network (ZEP).
+- Programming Environment
+  - Write native code in C, C++, or Rust
+  - Rely upon POSIX APIs, user friendly hardware abstractions and standard embedded Rust interfaces
+  - Integrate dynamic runtimes such as MicroPython, elm (JavaScript) and WASM
+- Network Features and Protocols
+  - IPv6
+  - IPv4 via lwIP
+  - 6LoWPAN (RFC4944, RFC6282, RFC6775 and RFC7668)
+  - UDP
+  - TCP
+  - RPL (storing mode, P2P mode)
+  - CoAP
+  - MQTT via paho-mqtt and MQTT-SN
+  - LwM2M
+  - Bluetooth (BLE) via [NimBLE][nimble]
+  - LoRaWAN
+  - UWB
+  - CAN
+  - CNN-Lite
+  - LwIP
+  - IEEE 802.15.4
+  - Ethernet (also via USB)
+  - SLIP (or ethos networking via Serial)
+  - Dose (single pair ethernet like networking on serial interface UART)
+- System Features
+  - a preemptive, tickless scheduler with priorities, optional periodic round robin within priorities
+  - flexible memory management
+  - high resolution, long-term timers
+  - MTD abstraction layer for memory devices
+  - File System integration
+- Security Features
+  - OTA updates via SUIT
+  - PSA Cryptographic API
+  - DTLS, EDHOC
+- Device Drivers
+  - SPI, I2C, UART, USB, CAN
+  - RTC, PWM, Timer
+  - ADC, DAC
+  - Various sensors: Environmental sensors, IMUs, magnetometers, particulate matter sensors
+  - Various actuators: Servos, motors, dimmers, switches, RGB LEDs
+  - Displays and touchscreens
+  - GNSS
+
+[nimble]: https://github.com/apache/mynewt-nimble
 
 ## Community
 
 You can ask for help on the Forum or on Matrix. Please send bug reports and
-feature requests to our [GitHub issue tracker](https://github.com/RIOT-OS/RIOT/issues)
+feature requests to our [GitHub issue tracker][issues]
 
-- [forum](https://forum.riot-os.org) is the default place to start asking for
-help. Our Forum provides an archive of prior questions and answers.
+- The [Forum][forum] is the default place to start asking for
+  help. Our Forum provides an archive of prior questions and answers.
 - For chat, we use
-  [#riot-os:matrix.org](https://matrix.to/#/#riot-os:matrix.org) on the
-  [Matrix](https://matrix.org/) chat network.
-- [GitHub Issue tracker](https://github.com/RIOT-OS/RIOT/issues) for issues
-with the code and documentation.
+  [#riot-os:matrix.org][matrix-chat] on the
+  [Matrix][matrix] chat network.
 
 ### Governance
 
-For how our community is structured and governed, please see our [governance document].
-
-[governance document]: GOVERNANCE.md
+For how our community is structured and governed,
+please see our [governance document][governance].
 
 ### How to Ask
 
@@ -154,7 +164,18 @@ only "this isn't working". These details include:
 
 ### Collaboration
 
-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).
+RIOT closely collaborates with and inspires other open source projects,
+e.g., [Ariel OS][ariel], an IoT OS written in Rust.
+We are more than happy to collaborate with those who share our
+[vision][vision].
+
+[issues]: https://github.com/RIOT-OS/RIOT/issues
+[forum]: https://forum.riot-os.org
+[matrix-chat]: https://matrix.to/#/#riot-os:matrix.org
+[matrix]: https://matrix.org/
+[governance]: https://guide.riot-os.org/general/governance/
+[ariel]: https://ariel-os.org/
+[vision]: https://guide.riot-os.org/general/vision/
 
 ## Getting RIOT
 
@@ -168,55 +189,45 @@ this will ensure that you get all the newest features and bug fixes with the
 caveat of an ever changing work environment.
 
 If you prefer things more stable, you can download the source code of one of our
-quarter annual releases [via Github][releases] as ZIP file or tarball. You can
-also checkout a release in a cloned Git repository using
+quarter annual releases [via Github][releases]
+as ZIP file or tarball. You can also checkout a release in
+a cloned Git repository using
 
 ```console
 $ git pull --tags
 $ git checkout <YYYY.MM>
 ```
 
-For more details on our release cycle, check our [documentation][release cycle].
+For more details on our release cycle, check our
+[documentation][release-cycle].
 
 [releases]: https://github.com/RIOT-OS/RIOT/releases
-[release cycle]: https://doc.riot-os.org/release-cycle.html
+[release-cycle]: https://guide.riot-os.org/misc/release_cycle/
 
 ## Contribute
 
 To contribute something to RIOT, please refer to our
-[contributing document](CONTRIBUTING.md).
+[contributing document][contributing].
+
+[contributing]: CONTRIBUTING.md
 
 ## Mailing Lists
-* Github notifications: [[email protected]](https://lists.riot-os.org/mailman/listinfo/notifications)
+
+- Github notifications:
+[[email protected]][notifications]
+
+[notifications]: https://lists.riot-os.org/postorius/lists/notifications.lists.riot-os.org/
 
 ## License
-* Most of the code developed by the RIOT community is licensed under the GNU
+
+- Most of the code developed by the RIOT community is licensed under the GNU
   Lesser General Public License (LGPL) version 2.1 as published by the Free
   Software Foundation.
-* Some external sources, especially files developed by SICS are published under
+- Some external sources, especially files developed by SICS are published under
   a separate license.
 
 All code files contain licensing information.
 
-For more information, see the RIOT website:
-
-https://www.riot-os.org
+For more information, see the [RIOT website][riot-website].
 
-
-[api-badge]: https://img.shields.io/badge/docs-API-informational.svg
-[api-link]: https://doc.riot-os.org/
-[license-badge]: https://img.shields.io/github/license/RIOT-OS/RIOT
-[license-link]: https://github.com/RIOT-OS/RIOT/blob/master/LICENSE
-[master-ci-badge]: https://ci.riot-os.org/job/branch/master/badge
-[master-ci-link]: https://ci.riot-os.org/details/branch/master
-[matrix-badge]: https://img.shields.io/badge/chat-Matrix-brightgreen.svg
-[matrix-link]: https://matrix.to/#/#riot-os:matrix.org
-[merge-chance-link]: https://merge-chance.info/target?repo=RIOT-OS/RIOT
-[release-badge]: https://img.shields.io/github/release/RIOT-OS/RIOT.svg
-[release-link]: https://github.com/RIOT-OS/RIOT/releases/latest
-[stackoverflow-badge]: https://img.shields.io/badge/stackoverflow-%5Briot--os%5D-yellow
-[stackoverflow-link]: https://stackoverflow.com/questions/tagged/riot-os
-[mastodon-badge]: https://img.shields.io/badge/social-Mastodon-informational.svg
-[mastodon-link]: https://floss.social/@RIOT_OS
-[wiki-badge]: https://img.shields.io/badge/docs-Wiki-informational.svg
-[wiki-link]: https://github.com/RIOT-OS/RIOT/wiki
+[riot-website]: https://www.riot-os.org

doc/doxygen/src/release-cycle.md

@@ -1,60 +1,5 @@
 Release cycle                                                   {#release-cycle}
 =============
 
-RIOT has a new release every three months and is named after the month it
-was feature frozen in. E.g. `2021.01` was feature frozen in January 2021.
-Feature freeze means the branch off point of the `<YYYY.MM>-branch` with
-`<YYYY.MM>` being the releases name. As such, any new feature merged into the
-`master` after that point, will be part of the next release. That branch, which
-we will call the release branch in the following is then the stable branch of
-RIOT.
-
-After feature freeze, the current release candidate in the release branch is
-tested heavily. For more information on the release testing, have a look at our
-[release specifications][release specs]. Bug fixes that are made during this
-testing period are back ported from `master` to the release branch and a new
-release candidate might be created when a certain milestone is found. If all
-major bugs are fixed, the new RIOT release is signed off by the appointed
-release manager, usually within 2 weeks after the feature freeze.
-More details and instructions for release managers can be found in the
-[managing a release guide].
-
-RIOT follows a rolling release cycle, meaning, that support and bug fixes are
-only provided for the most current release.
-
-Download a release                                                   {#download}
-==================
-
-You can download the source code of our releases [via Github][releases] as ZIP
-file or tarball. Alternatively, you can check them out if you already cloned
-RIOT with Git:
-
-~~~~~~~~~~~~~~~~~~~~
-$ git pull --tags
-$ git checkout <YYYY.MM>
-~~~~~~~~~~~~~~~~~~~~
-
-Point releases and hot fixes                                   {#point-releases}
-============================
-
-For major bug fixes, we may provide a point release `YYYY.MM.N` which results in
-a new ZIP file or tarball over at the [release page][releases]. However, minor
-bug fixes are only pushed to the release branch. You can fetch that via Git
-using
-
-~~~~~~~~~~~~~~~~~~~~
-$ git clone -b `<YYYY.MM>-branch` https://github.com/RIOT-OS/RIOT
-~~~~~~~~~~~~~~~~~~~~
-
-or
-
-~~~~~~~~~~~~~~~~~~~~
-$ git pull origin <YYYY.MM-branch>:<YYYY.MM-branch>
-$ git checkout <YYYY.MM-branch>
-~~~~~~~~~~~~~~~~~~~~
-
-if you have RIOT already cloned.
-
-[releases]: https://github.com/RIOT-OS/RIOT/releases
-[release specs]: https://github.com/RIOT-OS/Release-Specs
-[managing a release guide]: https://github.com/RIOT-OS/RIOT/tree/master/doc/guides/managing-a-release
+@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/release_cycle/).
+This page will be removed after release 2026.04.