From 0b6288c4c6166e649365d00d0b5331e1927497f7 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 10:41:34 +0100 Subject: [PATCH 1/7] Provide README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..706e467 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +[![Build Status](https://travis-ci.org/RIOT-OS/applications.svg?branch=master)](https://travis-ci.org/RIOT-OS/applications) + +This repository provides some applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for +development work, some showcase software provided with RIOT beyond the simple +examples within the RIOT codebase. + +To build and use them follow [the instructions in the RIOT repository][getting-started] +and the respective application's README. + +The submodule to the RIOT repository in this repository will always point to the +latest release. To change the RIOT version to build against (e.g. current +master), clone the RIOT repository in a separate repository and point the +`RIOTBASE` environment variable there: + +```sh +# assuming you are in the working directory of your local clone of this repo +cd .. +git clone git@github.com:RIOT-OS/RIOT.git +cd applications +RIOTBASE="../RIOT" BOARD=samr21-xpro make -C sniffer flash +``` + +[riot-repo]: https://github.com/RIOT-OS/RIOT +[getting-started]: https://github.com/RIOT-OS/RIOT/blob/master/README.md#getting-started From 37e35a4e5e2ec8a45b02e45e53d213cf32ebbcbd Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 10:56:57 +0100 Subject: [PATCH 2/7] fixup! Provide README Adding headlines --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 706e467..f652738 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ [![Build Status](https://travis-ci.org/RIOT-OS/applications.svg?branch=master)](https://travis-ci.org/RIOT-OS/applications) +# RIOT Applications + This repository provides some applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for development work, some showcase software provided with RIOT beyond the simple examples within the RIOT codebase. +## Usage + To build and use them follow [the instructions in the RIOT repository][getting-started] and the respective application's README. From 39ab7b0180beacda0936e5fedb9dcc3e81d2293d Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 10:59:29 +0100 Subject: [PATCH 3/7] fixup! Provide README Fix wording --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f652738..c131870 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ # RIOT Applications -This repository provides some applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for -development work, some showcase software provided with RIOT beyond the simple -examples within the RIOT codebase. +This repository provides more applications for the [RIOT operating system][riot-repo]. +Some of them are just useful tools for development work, others showcase +software provided with RIOT beyond the simple examples within the RIOT codebase. ## Usage From b07b9e47bdc4fef8b0967188bdddd7a83f8550ea Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 11:40:51 +0100 Subject: [PATCH 4/7] fixup! Provide README Address wording comments --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c131870..86911c9 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,18 @@ This repository provides more applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for development work, others showcase -software provided with RIOT beyond the simple examples within the RIOT codebase. +software provided with RIOT beyond the simple examples [within the RIOT +codebase][riot-repo/examples]. ## Usage To build and use them follow [the instructions in the RIOT repository][getting-started] -and the respective application's README. +and the READMEs within the respective application directory. -The submodule to the RIOT repository in this repository will always point to the -latest release. To change the RIOT version to build against (e.g. current -master), clone the RIOT repository in a separate repository and point the -`RIOTBASE` environment variable there: +The RIOT main code is included as a submodule. This always points to the latest +release. To change the RIOT version to build against (e.g. current master), +clone the RIOT repository in a separate repository and point the `RIOTBASE` +environment variable there: ```sh # assuming you are in the working directory of your local clone of this repo @@ -24,5 +25,17 @@ cd applications RIOTBASE="../RIOT" BOARD=samr21-xpro make -C sniffer flash ``` +Alternatively, you can step into the submodule and check out the current master: + +```sh +cd RIOT +git checkout master +git pull +``` + +Note, that this might lead to build errors, as we do not this repository against +current master. + [riot-repo]: https://github.com/RIOT-OS/RIOT +[riot-repo/examples]: https://github.com/RIOT-OS/RIOT/tree/master/examples [getting-started]: https://github.com/RIOT-OS/RIOT/blob/master/README.md#getting-started From 5433f4a8df3f103c7239d876f8e0be8445d432b6 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 11:51:39 +0100 Subject: [PATCH 5/7] fixup! Provide README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86911c9..1c34f2f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ This repository provides more applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for development work, others showcase -software provided with RIOT beyond the simple examples [within the RIOT -codebase][riot-repo/examples]. +more extensive implementations of features of RIOT compared to the rather simple +[examples in the RIOT main codebase][riot-repo/examples]. ## Usage From e797ab3b587a312d99920ffafb744d00ca2fce96 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 11:58:43 +0100 Subject: [PATCH 6/7] fixup! Provide README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c34f2f..1cfca97 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ git checkout master git pull ``` -Note, that this might lead to build errors, as we do not this repository against -current master. +Note, that there is no guarantee that it will build or work, since we only test +this repository against the latest release. [riot-repo]: https://github.com/RIOT-OS/RIOT [riot-repo/examples]: https://github.com/RIOT-OS/RIOT/tree/master/examples From 1adae9217abb62f1dd0b54fc3bc5cd29dc940db0 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Tue, 8 Jan 2019 12:01:41 +0100 Subject: [PATCH 7/7] fixup! Provide README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cfca97..5909c83 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ git checkout master git pull ``` -Note, that there is no guarantee that it will build or work, since we only test +Note that there is no guarantee that it will build or work, since we only test this repository against the latest release. [riot-repo]: https://github.com/RIOT-OS/RIOT