RIOT/README.md

[![Nightly CI status master][master-ci-badge]][master-ci-link]
[![IRC][irc-badge]][irc-link]
[![Matrix][matrix-badge]][matrix-link]

                          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!

RIOT is a real-time multi-threading operating system that supports a range of
devices that are typically found in the Internet of Things (IoT):
8-bit, 16-bit and 32-bit microcontrollers.

RIOT is based on the following design principles: energy-efficiency, real-time
capabilities, small memory footprint, modularity, and uniform API access,
independent of the underlying hardware (this API offers partial POSIX
compliance).

RIOT is developed by an international open source community which is
independent of specific vendors (e.g. similarly to the Linux community).
RIOT is licensed with LGPLv2.1, a copyleft license which fosters
indirect business models around the free open-source software platform
provided by RIOT, e.g. it is possible to link closed-source code with the
LGPL code.

## FEATURES

RIOT is based on a microkernel architecture, and provides features including,
but not limited to:

* a preemptive, tickless scheduler with priorities
* flexible memory management
* high resolution, long-term timers
* support 100+ boards based on AVR, MSP430, ESP8266, ESP32, MIPS, RISC-V,
  ARM7 and ARM Cortex-M
* 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
* IPv6
* 6LoWPAN (RFC4944, RFC6282, and RFC6775)
* UDP
* RPL (storing mode, P2P mode)
* CoAP
* CCN-Lite
* Sigfox
* LoRaWAN


## GETTING STARTED
* You want to start the RIOT? Just follow our
[quickstart guide](https://doc.riot-os.org/index.html#the-quickest-start) or
try this
[tutorial](https://github.com/RIOT-OS/Tutorials/blob/master/README.md).
For specific toolchain installation, follow instructions in the
[getting started](https://doc.riot-os.org/getting-started.html) page.
* The RIOT API itself can be built from the code using doxygen. The latest
  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
[contributing document](CONTRIBUTING.md).

## MAILING LISTS
* RIOT OS kernel developers list
 * devel@riot-os.org (https://lists.riot-os.org/mailman/listinfo/devel)
* RIOT OS users list
 * users@riot-os.org (https://lists.riot-os.org/mailman/listinfo/users)
* RIOT commits
 * commits@riot-os.org (https://lists.riot-os.org/mailman/listinfo/commits)
* Github notifications
 * notifications@riot-os.org
   (https://lists.riot-os.org/mailman/listinfo/notifications)

## LICENSE
* Most of the code developed by the RIOT community is licensed under the GNU
  Lesser General Public License (LGPL) version 2.1 as published by the Free
  Software Foundation.
* Some external sources, especially files developed by SICS are published under
  a separate license.

All code files contain licensing information.

For more information, see the RIOT website:

https://www.riot-os.org


[master-ci-badge]: https://ci.riot-os.org/RIOT-OS/RIOT/master/latest/badge.svg
[master-ci-link]: https://ci.riot-os.org/nightlies.html#master
[irc-badge]: https://img.shields.io/badge/IRC-join%20chat%20%E2%86%92-blue.svg
[irc-link]: https://webchat.freenode.net?channels=%23riot-os
[matrix-badge]: https://img.shields.io/badge/Matrix-join%20chat%20%E2%86%92-blue.svg
[matrix-link]: https://matrix.to/#/#riot-os:matrix.org
readme: add badge to join IRC easily 2018-04-16 15:09:18 +02:00			`[![Nightly CI status master][master-ci-badge]][master-ci-link]`
			`[![IRC][irc-badge]][irc-link]`
README: add shield for the Matrix chat network 2020-02-04 15:56:56 +01:00			`[![Matrix][matrix-badge]][matrix-link]`
doc: Add nightly build status of master to README 2018-04-11 12:38:59 +02:00
remove trailing whitespace and newlines 2014-02-11 18:15:43 +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`

* merged README files 2013-03-21 17:13:01 +01:00			`The friendly Operating System for IoT!`
* added readme file 2012-12-29 21:42:26 +01:00
Update README Used some reworked umbrella text from latest release notes to provide more synthetic information upfront (as this README is the first thing people read on GitHub). 2016-05-31 13:10:51 +02:00			`RIOT is a real-time multi-threading operating system that supports a range of`
readme: add badge to join IRC easily 2018-04-16 15:09:18 +02:00			`devices that are typically found in the Internet of Things (IoT):`
Update README.md addressed comments 2016-05-31 19:23:35 +02:00			`8-bit, 16-bit and 32-bit microcontrollers.`
Update README Used some reworked umbrella text from latest release notes to provide more synthetic information upfront (as this README is the first thing people read on GitHub). 2016-05-31 13:10:51 +02:00
			`RIOT is based on the following design principles: energy-efficiency, real-time`
			`capabilities, small memory footprint, modularity, and uniform API access,`
			`independent of the underlying hardware (this API offers partial POSIX`
			`compliance).`

			`RIOT is developed by an international open source community which is`
Update README.md wordsmithing around non-viral term 2016-05-31 15:25:04 +02:00			`independent of specific vendors (e.g. similarly to the Linux community).`
			`RIOT is licensed with LGPLv2.1, a copyleft license which fosters`
Update README Used some reworked umbrella text from latest release notes to provide more synthetic information upfront (as this README is the first thing people read on GitHub). 2016-05-31 13:10:51 +02:00			`indirect business models around the free open-source software platform`
Update README.md wordsmithing around non-viral term 2016-05-31 15:25:04 +02:00			`provided by RIOT, e.g. it is possible to link closed-source code with the`
			`LGPL code.`
Update README Used some reworked umbrella text from latest release notes to provide more synthetic information upfront (as this README is the first thing people read on GitHub). 2016-05-31 13:10:51 +02:00
added native networking to the feature list in README and reordered the file 2013-08-15 17:15:24 +02:00			`## FEATURES`
* added readme file 2012-12-29 21:42:26 +01:00
README: obey character limit 2016-06-13 12:03:03 +02:00			`RIOT is based on a microkernel architecture, and provides features including,`
			`but not limited to:`
Update README Used some reworked umbrella text from latest release notes to provide more synthetic information upfront (as this README is the first thing people read on GitHub). 2016-05-31 13:10:51 +02:00
* added readme file 2012-12-29 21:42:26 +01:00			`* a preemptive, tickless scheduler with priorities`
fix spelling error in README.md 2014-01-13 11:19:45 +01:00			`* flexible memory management`
README: slight update 2016-02-29 18:46:36 +01:00			`* high resolution, long-term timers`
Documentation: update README with new architectures supported 2019-03-26 16:44:47 +01:00			`* support 100+ boards based on AVR, MSP430, ESP8266, ESP32, MIPS, RISC-V,`
			`ARM7 and ARM Cortex-M`
README: obey character limit 2016-06-13 12:03:03 +02:00			`* 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`
* added readme file 2012-12-29 21:42:26 +01:00			`* IPv6`
README: slight update 2016-02-29 18:46:36 +01:00			`* 6LoWPAN (RFC4944, RFC6282, and RFC6775)`
remove temporarily dropped features from README.md 2015-08-06 12:08:58 +02:00			`* UDP`
Update README.md addressed comments 2016-05-31 19:23:35 +02:00			`* RPL (storing mode, P2P mode)`
README: slight update 2016-02-29 18:46:36 +01:00			`* CoAP`
			`* CCN-Lite`
README: add Sigfox and LoRaWAN to features list 2018-02-13 14:51:31 +01:00			`* Sigfox`
README: remove experimental state from LoRaWAN 2018-09-26 11:37:52 +02:00			`* LoRaWAN`
Update README.md addressed comments 2016-05-31 19:23:35 +02:00
remove trailing whitespace and newlines 2014-02-11 18:15:43 +01:00
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00			`## GETTING STARTED`
README: make lines fit in 80 characters length 2018-02-13 14:52:44 +01:00			`* You want to start the RIOT? Just follow our`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`[quickstart guide](https://doc.riot-os.org/index.html#the-quickest-start) or`
README: make lines fit in 80 characters length 2018-02-13 14:52:44 +01:00			`try this`
			`[tutorial](https://github.com/RIOT-OS/Tutorials/blob/master/README.md).`
			`For specific toolchain installation, follow instructions in the`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`[getting started](https://doc.riot-os.org/getting-started.html) page.`
README: obey character limit 2016-06-13 12:03:03 +02:00			`* The RIOT API itself can be built from the code using doxygen. The latest`
README: make lines fit in 80 characters length 2018-02-13 14:52:44 +01:00			`version of the documentation is uploaded daily to`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`[riot-os.org/api](https://riot-os.org/api).`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00			`### USING THE NATIVE PORT WITH NETWORKING`
netdev2: rename to netdev and remove `gnrc_netdev` With some minor hand-edits I used the following chain of commands: ```sh git rm sys/include/net/gnrc/netdev.h git grep --name-only -i netdev2 \| \ xargs sed -i -e 's/^\(NETDEV\)2\(.\)\( [("]\)/\1\2 \3/g' \ -e 's/\(netdev\)2\(.\)\( \/\\<\)/\1\2 \3/I' \ -e 's/\(netdev\)2/\1/gI' git add -p git commit --amend git ls-tree --full-tree -r HEAD --name-only \| \ grep "netdev2" \| xargs -I'{}' dirname '{}' \| uniq \| \ grep "netdev2" \| while read dir; do new_dir="$(echo "$dir" \| sed "s/netdev2/netdev/g")" git mv -f "$dir" "$new_dir" done git commit --amend git ls-tree --full-tree -r HEAD --name-only \| \ grep "netdev2" \| while read file; do new_file="$(echo "$file" \| sed "s/netdev2/netdev/g")" git mv -f "$file" "$new_file" done git commit --amend git grep --name-only "\<drivers_netdev_netdev\>" \| \ xargs sed -i "s/\<drivers_netdev_netdev\>/drivers_netdev_api/g" git add -p git commit --amend ``` 2017-02-15 13:07:34 +01:00			If you compile RIOT for the native cpu and include the `netdev_tap` module,
README: obey character limit 2016-06-13 12:03:03 +02:00			you can specify a network interface like this: `PORT=tap0 make term`
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00
			`#### SETTING UP A TAP NETWORK`
README: cleanup in tap network section 2018-03-04 12:58:14 +01:00			There is a shell script in `RIOT/dist/tools/tapsetup` called `tapsetup` which
README: obey character limit 2016-06-13 12:03:03 +02:00			`you can use to create a network of tap interfaces.`
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00
			`USAGE`
README: cleanup in tap network section 2018-03-04 12:58:14 +01:00
			To create a bridge and two (or `count` at your option) tap interfaces:
doc: adapt documentation on tapsetup script 2015-06-14 01:29:55 +02:00
README.md: adapt doc on tapsetup for new sudo requirement 2019-07-23 13:30:20 +02:00			`sudo ./dist/tools/tapsetup/tapsetup [-c [<count>]]`
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00
added native networking to the feature list in README and reordered the file 2013-08-15 17:15:24 +02:00			`## CONTRIBUTE`

CONTRIBUTING: complete rewrite 2018-09-25 15:45:45 +02:00			`To contribute something to RIOT, please refer to our`
			`[contributing document](CONTRIBUTING.md).`
added native networking to the feature list in README and reordered the file 2013-08-15 17:15:24 +02:00
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00			`## MAILING LISTS`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00			`* RIOT OS kernel developers list`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`* devel@riot-os.org (https://lists.riot-os.org/mailman/listinfo/devel)`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00			`* RIOT OS users list`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`* users@riot-os.org (https://lists.riot-os.org/mailman/listinfo/users)`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00			`* RIOT commits`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`* commits@riot-os.org (https://lists.riot-os.org/mailman/listinfo/commits)`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00			`* Github notifications`
README: obey character limit 2016-06-13 12:03:03 +02:00			`* notifications@riot-os.org`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`(https://lists.riot-os.org/mailman/listinfo/notifications)`
added mailing lists and getting started information, fixed some links 2013-08-08 20:36:59 +02:00
added some documentation to README * documentation about native networking * section about examples * markdown formatting 2013-08-15 13:07:27 +02:00			`## LICENSE`
README: remove FUB mention from license statement 2016-06-13 12:03:40 +02:00			`* Most of the code developed by the RIOT community is licensed under the GNU`
			`Lesser General Public License (LGPL) version 2.1 as published by the Free`
			`Software Foundation.`
* merged README files 2013-03-21 17:13:01 +01:00			`* Some external sources, especially files developed by SICS are published under`
			`a separate license.`
remove trailing whitespace and newlines 2014-02-11 18:15:43 +01:00
* merged README files 2013-03-21 17:13:01 +01:00			`All code files contain licensing information.`
* added website's URL to readme file 2013-03-27 11:01:48 +01:00
			`For more information, see the RIOT website:`

[doc] links http -> https 2018-10-21 15:36:00 +02:00			`https://www.riot-os.org`
readme: add badge to join IRC easily 2018-04-16 15:09:18 +02:00

			`[master-ci-badge]: https://ci.riot-os.org/RIOT-OS/RIOT/master/latest/badge.svg`
README.md: move link to nightly build overview Now that we have a nice [HTML view of all nightly builds][nightlies], let's link to them! [nightlies]: https://ci.riot-os.org/nightlies.html#master 2018-09-09 17:51:08 +02:00			`[master-ci-link]: https://ci.riot-os.org/nightlies.html#master`
readme: add badge to join IRC easily 2018-04-16 15:09:18 +02:00			`[irc-badge]: https://img.shields.io/badge/IRC-join%20chat%20%E2%86%92-blue.svg`
[doc] links http -> https 2018-10-21 15:36:00 +02:00			`[irc-link]: https://webchat.freenode.net?channels=%23riot-os`
README: add shield for the Matrix chat network 2020-02-04 15:56:56 +01:00			`[matrix-badge]: https://img.shields.io/badge/Matrix-join%20chat%20%E2%86%92-blue.svg`
			`[matrix-link]: https://matrix.to/#/#riot-os:matrix.org`