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 1 commit
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
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[![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
This repository provides some applications for the [RIOT operating system][riot-repo]. Some of them are just useful tools for
miri64 marked this conversation as resolved.
Show resolved Hide resolved
development work, some showcase software provided with RIOT beyond the simple
examples within the RIOT codebase.

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 respective application's README.
miri64 marked this conversation as resolved.
Show resolved Hide resolved

The submodule to the RIOT repository in this repository will always point to the
miri64 marked this conversation as resolved.
Show resolved Hide resolved
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
```

[riot-repo]: https://github.com/RIOT-OS/RIOT
[getting-started]: https://github.com/RIOT-OS/RIOT/blob/master/README.md#getting-started