Browse Source

added some documentation to README

* documentation about native networking
* section about examples
* markdown formatting
dev/timer
Oleg Hahm 9 years ago
parent
commit
eec0e8b2b0
  1. 29
      README.md

29
README.md

@ -42,8 +42,7 @@ Its features comprise
* 6LoWPAN
* RPL
Development Procedures
======================
## DEVELOPMENT PROCEDURES
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.
@ -60,13 +59,26 @@ Development Procedures
8. Describe the technical detail of the change(s) as specific as possible.
Getting Started
===============
* You want to start the RIOT? Just follow our Getting started documentation: http://riot-os.org/doc/getting_started.html
## GETTING STARTED
* You want to start the RIOT? Just follow our [Getting started documentation](http://riot-os.org/doc/getting_started.html)
* The RIOT API itself can be built from the code using doxygen. The latest version is uploaded daily to http://riot-os.org/api.
Mailing Lists
=============
### USING THE NATIVE PORT WITH NETWORKING
If you compile RIOT for the native cpu and include the nativenet module, you need to specify a network interface like this: `./bin/default-native.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
In the `projects` repository you can find some example applications. The `default` application demonstrates all available features for the current platform.
For example, you can use it to the test the native networking by running the `bin/default-native.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".
## MAILING LISTS
* RIOT OS kernel developers list
* devel@riot-os.org (http://lists.riot-os.org/mailman/listinfo/devel)
* RIOT OS users list
@ -76,8 +88,7 @@ Mailing Lists
* Github notifications
* notifications@riot-os.org (http://lists.riot-os.org/mailman/listinfo/notifications)
License
=======
## LICENSE
* 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
Free Software Foundation.

Loading…
Cancel
Save