diff --git a/README.md b/README.md index 24b56d1d45..812ae19f7d 100644 --- a/README.md +++ b/README.md @@ -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 []] - ## CONTRIBUTE To contribute something to RIOT, please refer to our diff --git a/doc/doxygen/src/getting-started.md b/doc/doxygen/src/getting-started.md index 831b098dd6..302cab382f 100644 --- a/doc/doxygen/src/getting-started.md +++ b/doc/doxygen/src/getting-started.md @@ -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 []] +~~~~~~~