Skip to content

Commit b8a723d

Browse files
committed
readme: modernize getting started section
1 parent 5136d23 commit b8a723d

File tree

1 file changed

+34
-37
lines changed

1 file changed

+34
-37
lines changed

README.md

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -82,46 +82,18 @@ RIOT provides features including, but not limited to:
8282
* UWB
8383
* Bluetooth (BLE) via [NimBLE](https://github.com/apache/mynewt-nimble)
8484

85-
## Getting RIOT
86-
87-
The most convenient way to get RIOT is to clone it via Git
88-
89-
```console
90-
$ git clone https://github.com/RIOT-OS/RIOT
91-
```
92-
93-
this will ensure that you get all the newest features and bug fixes with the
94-
caveat of an ever changing work environment.
95-
96-
If you prefer things more stable, you can download the source code of one of our
97-
quarter annual releases [via Github][releases] as ZIP file or tarball. You can
98-
also checkout a release in a cloned Git repository using
99-
100-
```console
101-
$ git pull --tags
102-
$ git checkout <YYYY.MM>
103-
```
104-
105-
For more details on our release cycle, check our [documentation][release cycle].
106-
107-
[releases]: https://github.com/RIOT-OS/RIOT/releases
108-
[release cycle]: https://doc.riot-os.org/release-cycle.html
109-
11085
## Getting Started
111-
* You want to start the RIOT? Just follow our
112-
[quickstart guide](https://doc.riot-os.org/index.html#the-quickest-start) or
113-
try this
114-
[tutorial](https://github.com/RIOT-OS/Tutorials/blob/master/README.md).
115-
For specific toolchain installation, follow instructions in the
116-
[getting started](https://doc.riot-os.org/getting-started.html) page.
117-
* The RIOT API itself can be built from the code using doxygen. The latest
118-
version of the documentation is uploaded daily to
119-
[doc.riot-os.org](https://doc.riot-os.org).
12086

121-
Using Windows? Use [this guide][dev-setup-windows] to
122-
[setup the development environment][dev-setup-windows].
87+
* **Start here:**
88+
Our comprehensive [Getting Started Guide](https://guide.riot-os.org/getting-started/installing/)
89+
walks you through installation and your first RIOT applications.
90+
91+
* **Learn by doing:**
92+
* Try our [hands-on tutorials](https://github.com/RIOT-OS/Tutorials) designed for beginners
93+
* Take the [RIOT online course](https://github.com/RIOT-OS/riot-course) at your own pace
12394

124-
[dev-setup-windows]: doc/guides/setup-windows
95+
* **Explore the API:** Check out the [API documentation](https://doc.riot-os.org/)
96+
for detailed information on RIOT's features and functions.
12597

12698
## Community
12799

@@ -155,6 +127,31 @@ only "this isn't working". These details include:
155127

156128
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).
157129

130+
## Getting RIOT
131+
132+
The most convenient way to get RIOT is to clone it via Git
133+
134+
```console
135+
$ git clone https://github.com/RIOT-OS/RIOT
136+
```
137+
138+
this will ensure that you get all the newest features and bug fixes with the
139+
caveat of an ever changing work environment.
140+
141+
If you prefer things more stable, you can download the source code of one of our
142+
quarter annual releases [via Github][releases] as ZIP file or tarball. You can
143+
also checkout a release in a cloned Git repository using
144+
145+
```console
146+
$ git pull --tags
147+
$ git checkout <YYYY.MM>
148+
```
149+
150+
For more details on our release cycle, check our [documentation][release cycle].
151+
152+
[releases]: https://github.com/RIOT-OS/RIOT/releases
153+
[release cycle]: https://doc.riot-os.org/release-cycle.html
154+
158155
## Contribute
159156

160157
To contribute something to RIOT, please refer to our

0 commit comments

Comments
 (0)