Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

Provide README #58

Merged
merged 7 commits into from
Feb 18, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[![Build Status](https://travis-ci.org/RIOT-OS/applications.svg?branch=master)](https://travis-ci.org/RIOT-OS/applications)

miri64 marked this conversation as resolved.
Show resolved Hide resolved
# RIOT Applications

This repository provides more applications for the [RIOT operating system][riot-repo].
Some of them are just useful tools for development work, others showcase
more extensive implementations of features of RIOT compared to the rather simple
[examples in the RIOT main codebase][riot-repo/examples].

miri64 marked this conversation as resolved.
Show resolved Hide resolved
## Usage

miri64 marked this conversation as resolved.
Show resolved Hide resolved
To build and use them follow [the instructions in the RIOT repository][getting-started]
and the READMEs within the respective application directory.

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
cd ..
git clone [email protected]:RIOT-OS/RIOT.git
miri64 marked this conversation as resolved.
Show resolved Hide resolved
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 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
[getting-started]: https://github.com/RIOT-OS/RIOT/blob/master/README.md#getting-started