1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/README.md

105 lines
6.4 KiB
Markdown
Raw Normal View History

2013-03-21 17:13:01 +01:00
ZZZZZZ
ZZZZZZZZZZZZ
ZZZZZZZZZZZZZZZZ
ZZZZZZZ ZZZZZZ
ZZZZZZ ZZZZZ
ZZZZZ ZZZZ
ZZZZ ZZZZZ
ZZZZ ZZZZ
ZZZZ ZZZZZ
ZZZZ ZZZZZZ
ZZZZ ZZZZZZZZ 777 7777 7777777777
ZZ ZZZZ ZZZZZZZZ 777 77777777 77777777777
ZZZZZZZ ZZZZ ZZZZZZZ 777 7777 7777 777
ZZZZZZZZZ ZZZZ Z 777 777 777 777
ZZZZZZ ZZZZ 777 777 777 777
ZZZZZ ZZZZ 777 777 777 777
ZZZZZ ZZZZZ ZZZZ 777 777 777 777
ZZZZ ZZZZZ ZZZZZ 777 777 777 777
ZZZZ ZZZZZ ZZZZZ 777 777 777 777
ZZZZ ZZZZ ZZZZZ 777 777 777 777
ZZZZZ ZZZZZ ZZZZZ 777 777 777 777
ZZZZZZ ZZZZZZ ZZZZZ 777 7777777777 777
ZZZZZZZZZZZZZZZ ZZZZ 777 77777777 777
ZZZZZZZZZZZ Z
ZZZZZ
The friendly Operating System for IoT!
2012-12-29 21:42:26 +01:00
## FEATURES
RIOT OS is an operating system for Internet of Things (IoT) devices. It is based on a microkernel and designed for
2012-12-29 21:42:26 +01:00
* energy efficiency
* hardware independent development
* a high degree of modularity
Its features comprise
* a preemptive, tickless scheduler with priorities
2014-01-13 11:19:45 +01:00
* flexible memory management
2012-12-29 21:42:26 +01:00
* high resolution timers
* virtual, long-term timers
* the native port allows to run RIOT as-is on Linux, BSD, and MacOS. Multiple instances of RIOT running on a single machine can also be interconnected via a simple virtual Ethernet bridge
2012-12-29 21:42:26 +01:00
* Wiselib support (C++ algorithm library, including routing, clustering, timesync, localization, security and more algorithms)
* IPv6
* TCP and UDP
* 6LoWPAN
* RPL
## GETTING STARTED
* You want to start the RIOT? Just follow our [Getting started documentation](https://github.com/RIOT-OS/RIOT/wiki/Introduction)
* The RIOT API itself can be built from the code using doxygen. The latest version is uploaded daily to http://riot-os.org/api.
### USING THE NATIVE PORT WITH NETWORKING
2014-02-01 12:22:00 +01:00
If you compile RIOT for the native cpu and include the nativenet module, you need to specify a network interface like this: `./bin/native/default.elf tap0`
#### SETTING UP A TAP NETWORK
There is a shellscript in `RIOT/cpu/native` called `tapsetup.sh` which you can use to create a network of tap interfaces.
*USAGE*
To create a bridge and two (or count at your option) tap interfaces:
./tapsetup.sh create [count]
### EXAMPLE APPLICATIONS
2014-01-22 19:10:43 +01:00
In the `examples` directory you can find some example applications. The `default` application demonstrates all available features for the current platform.
2014-02-01 12:22:00 +01:00
For example, you can use it to the test the native networking by running the `./bin/native/default.elf` twice with two different tap interfaces as parameters, e.g. tap0 and tap1. Now configure two different addresses for both RIOT instances by typing `addr 1` and `addr 2`accordingly and send a text message from one "node" to another by typing `txtsnd 2 hello` on the first "node".
## CONTRIBUTE
1. Check if your code follows the https://github.com/RIOT-OS/RIOT/wiki/Coding-conventions. If the code does not comply these style rules, your code will not be merged.
2. Create a new branch in your own fork for every new feature or fix. Then create the pull request from this branch, once you completed your task (feature or fix). Every commit in this branch will be added to the pull request.
3. The master branch should always be in a working state. The RIOT maintainers will create release tags based on this branch, whenever a milestone is completed.
4. New features and fixes will always be submitted as pull requests. A pull request will be merged if the RIOT maintainers acknowledge the request. Before it will get merged, the pull request has to stay open long enough to discuss possible issues, but no longer than 30 days. The more extensive the changes in the pull request, the more time should be given for discussion.
5. Comments on a pull request should be added to the request itself, and *not* to the commit.
6. Only RIOT maintainers have commit rights to the main RIOT repository. However, even they have to create pull requests to submit their changes. A RIOT contributor cannot acknowledge his own pull request. All current RIOT maintainers are listed in the wiki.
7. Keep commits to the point, e.g., don't add whitespace/typo fixes to other code changes. If changes are layered, layer the patches.
8. Describe the technical detail of the change(s) as specific as possible.
## MAILING LISTS
* RIOT OS kernel developers list
* devel@riot-os.org (http://lists.riot-os.org/mailman/listinfo/devel)
* RIOT OS users list
* users@riot-os.org (http://lists.riot-os.org/mailman/listinfo/users)
* RIOT commits
* commits@riot-os.org (http://lists.riot-os.org/mailman/listinfo/commits)
* Github notifications
* notifications@riot-os.org (http://lists.riot-os.org/mailman/listinfo/notifications)
## LICENSE
2013-03-21 17:13:01 +01:00
* All sources and binaries that have been developed at Freie Universität Berlin are
licensed under the GNU Lesser General Public License version 2 as published by the
2013-03-21 17:13:01 +01:00
Free Software Foundation.
* Some external sources, especially files developed by SICS are published under
a separate license.
All code files contain licensing information.
2013-03-27 11:01:48 +01:00
For more information, see the RIOT website:
http://www.riot-os.org