From 8f60f29975202d3d0112474128a375726cf2ecec Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Wed, 24 Feb 2021 16:08:38 +0100 Subject: [PATCH] README: Add documentation on downloading RIOT Signed-off-by: Martine Lenders --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 5473e34992..73cdfd41ba 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,30 @@ but not limited to: * Sigfox * LoRaWAN +## GETTING RIOT + +The most convenient way to get RIOT is to clone it via Git + +```console +$ git clone https://github.com/RIOT-OS/RIOT +``` + +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 + +```console +$ git pull --tags +$ git checkout +``` + +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 ## GETTING STARTED * You want to start the RIOT? Just follow our