Skip to content
LudwigOrtmann edited this page Dec 12, 2014 · 20 revisions

Under what license is RIOT code released?

The license is currently LGPLv2.

Why LGPL?

We want to ensure that improvements to RIOT itself find their way back to the project, but we'd also allow proprietary projects to use RIOT without GPLing their code. LGPL allows linking proprietary code to RIOT code without tainting the proprietary code's license. Compare https://github.com/RIOT-OS/RIOT/issues/2128

How is RIOT development organized?

In short there are certain Coding Conventions to follow and we are using Github's pull requests for code review. So for new features and fixes create a fork of the RIOT repository and open a pull request with a detailed description of your changes.

For a more in depth description check out the dedicated page on development procedures.

What should be my first steps to get started?

So we attracted your attention? That's great!
The Quick Start Guide might be just what you are looking for.

I want to contribute. How should I proceed?

First of all, welcome to the RIOT community! There is a dedicated page on contributing listing opportunities to interact with fellow RIOT enthusiasts and some suggestions how to get started.

I have an issue with RIOT code I can't solve. How can I get help?

Log an issue in GitHub. Then post to the mailing list [email protected] and/or [email protected]. You're also welcome to ask in the IRC channel #riot-os at irc.freenode.net, but don't be disappointed if everyone there is busy.

Does RIOT run as-is on my hardware?

Check out this page on supported hardware. If your hardware is not listed there, you're welcome to provide a port for your hardware!

How much memory (ROM/RAM) will it need?

This depends on the board and on the application. When you compile an application for a board, the last thing printed gives each sections memory footprint and looks like this:

text       data     bss     dec     hex filename
  77732     296   24272  102300    18f9c applications/sixlowapp/bin/iot-lab_M3/sixlowapp.elf

The required RAM is data + bss, ROM is text + bss.

Clone this wiki locally