Skip to content
Snippets Groups Projects
README.md 5.06 KiB
Newer Older
  • Learn to ignore specific revisions
  • [![Nightly CI status master][master-ci-badge]][master-ci-link]
    [![IRC][irc-badge]][irc-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
    
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    The friendly Operating System for IoT!
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    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):
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    8-bit, 16-bit and 32-bit microcontrollers.
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    
    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
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    independent of specific vendors (e.g. similarly to the Linux community).
    RIOT is licensed with LGPLv2.1, a copyleft license which fosters
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    indirect business models around the free open-source software platform
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    provided by RIOT, e.g. it is possible to link closed-source code with the
    LGPL code.
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    RIOT is based on a microkernel architecture, and provides features including,
    but not limited to:
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * a preemptive, tickless scheduler with priorities
    
    * flexible memory management
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * high resolution, long-term timers
    
    * support 100+ boards based on AVR, MSP430, ESP8266, MIPS, ARM7 and ARM Cortex-M
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * 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
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * IPv6
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * 6LoWPAN (RFC4944, RFC6282, and RFC6775)
    
    Emmanuel Baccelli's avatar
    Emmanuel Baccelli committed
    * RPL (storing mode, P2P mode)
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * CoAP
    * CCN-Lite
    
    ## GETTING STARTED
    
    * You want to start the RIOT? Just follow our
    
    Rotzbua's avatar
    Rotzbua committed
    [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
    
    Rotzbua's avatar
    Rotzbua committed
    [getting started](https://doc.riot-os.org/getting-started.html) page.
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * The RIOT API itself can be built from the code using doxygen. The latest
    
      version of the documentation is uploaded daily to
    
    Rotzbua's avatar
    Rotzbua committed
      [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,
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    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
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    you can use to create a network of tap interfaces.
    
    
    To create a bridge and two (or `count` at your option) tap interfaces:
    
    
        ./dist/tools/tapsetup/tapsetup [-c [<count>]]
    
    To contribute something to RIOT, please refer to our
    [contributing document](CONTRIBUTING.md).
    
    ## MAILING LISTS
    
    * RIOT OS kernel developers list
    
    Rotzbua's avatar
    Rotzbua committed
     * devel@riot-os.org (https://lists.riot-os.org/mailman/listinfo/devel)
    
    Rotzbua's avatar
    Rotzbua committed
     * users@riot-os.org (https://lists.riot-os.org/mailman/listinfo/users)
    
    Rotzbua's avatar
    Rotzbua committed
     * commits@riot-os.org (https://lists.riot-os.org/mailman/listinfo/commits)
    
    Oleg Hahm's avatar
    Oleg Hahm committed
     * notifications@riot-os.org
    
    Rotzbua's avatar
    Rotzbua committed
       (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.
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    * Some external sources, especially files developed by SICS are published under
      a separate license.
    
    Oleg Hahm's avatar
    Oleg Hahm committed
    All code files contain licensing information.
    
    
    For more information, see the RIOT website:
    
    
    Rotzbua's avatar
    Rotzbua committed
    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
    
    Rotzbua's avatar
    Rotzbua committed
    [irc-link]: https://webchat.freenode.net?channels=%23riot-os