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

Merge pull request #15154 from aabadie/pr/doc/cleanup_readme

Browse Source 
README.md: move tapsetup section to documentation
This commit is contained in:
benpicco 2020-10-06 10:31:25 +02:00 committed by GitHub
commit 5c9e0dfa93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -86,20 +86,6 @@ For specific toolchain installation, follow instructions in the
version of the documentation is uploaded daily to
[riot-os.org/api](https://riot-os.org/api).
### USING THE NATIVE PORT WITH NETWORKING
If you compile RIOT for the native cpu and include the `netdev_tap` module,
you can specify a network interface like this: `PORT=tap0 make term`
#### SETTING UP A TAP NETWORK
There is a shell script in `RIOT/dist/tools/tapsetup` called `tapsetup` 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:
sudo ./dist/tools/tapsetup/tapsetup [-c [<count>]]
## CONTRIBUTE
To contribute something to RIOT, please refer to our

19
doc/doxygen/src/getting-started.md
View File

@ -152,3 +152,22 @@ subset of modules).
For instructions on how to configure via `CFLAGS` check the
@ref config "identified compile-time configurations". To learn how to use
Kconfig in RIOT, please refer to the @ref kconfig-users-guide.
Using the native port with networking
=====================================
If you compile RIOT for the native cpu and include the `netdev_tap` module,
you can specify a network interface like this: `PORT=tap0 make term`
Setting up a tap network
------------------------
There is a shell script in `RIOT/dist/tools/tapsetup` called `tapsetup` 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:
~~~~~~~{.sh}
sudo ./dist/tools/tapsetup/tapsetup [-c [<count>]]
~~~~~~~