examples/readme: switch to tableformat

examples: Remove whitespace to fix CI

examples/README.md

@@ -8,27 +8,16 @@ Here is a quick overview of the examples available in the RIOT:
 
 ## The Essentials
 
-- [default](./default/README.md)
+| Example | Description |
-  - This application is a showcase for RIOT's hardware support. Using it
+|---------|-------------|
-    for your board, you should be able to interactively use any hardware
+| [default](./default/README.md) | This application is a showcase for RIOT's hardware support. Using it for your board, you should be able to interactively use any hardware that is supported. |
-    that is supported.
+| [hello-world](./hello-world/README.md) | A simple "Hello World" that shows the basic structure of a RIOT application. |
-- [hello-world](./hello-world/README.md)
+| [blinky](./blinky/README.md) | The classic "Hello World" example for embedded systems: blinking an LED (or printing "Blink!" via stdio when none are available). |
-  - A simple "Hello World" that shows the basic structure of a RIOT application.
+| [leds_shell](./leds_shell/README.md) | The application `leds_shell` is a basic example, which allows easy, interactive control of internal board LEDs, and basic GPIO for externally connected simple devices (for e.g. additional LEDs, relay, motors - via dedicated drivers, etc.) via the shell. |
-- [blinky](./blinky/README.md)
+| [saul](./saul/README.md) | This example demonstrates the usage of the SAUL (Sensor Actuator Uber Layer) module. |
-  - The classic "Hello World" example for embedded systems: blinking an LED (or printing "Blink!" via stdio when none are available).
+| [timer_periodic_wakeup](./timer_periodic_wakeup/README.md) | How to set up a periodic wakeup timer using the RIOT operating system. |
-- [leds_shell](./leds_shell/README.md)
+| [ipc_pingpong](./ipc_pingpong/README.md) | This example is to illustrate the usage of RIOTs IPC messaging system. |
-  - The application `leds_shell` is a basic example, which allows easy, interactive
+| [filesystem](./filesystem/README.md) | This example showcases ways to interact/manage the filesystem in RIOT. |
-    control of internal board LEDs, and basic GPIO for externally connected simple
-    devices (for e.g. additional LEDs, relay, motors - via dedicated drivers, etc.)
-    via the shell.
-- [saul](./saul/README.md)
-  - This example demonstrates the usage of the SAUL (Sensor Actuator Uber Layer) module.
-- [timer_periodic_wakeup](./timer_periodic_wakeup/README.md)
-  - How to set up a periodic wakeup timer using the RIOT operating system.
-- [ipc_pingpong](./ipc_pingpong/README.md)
-  - This example is to illustrate the usage of RIOTs IPC messaging system.
-- [filesystem](./filesystem/README.md)
-  - This example showcases ways to interact/manage the filesystem in RIOT.
 
 ### RIOT Language Bindings
 
@@ -36,139 +25,95 @@ Here is a quick overview of the examples available in the RIOT:
 
 ##### _Rust_
 
-- [rust-hello-world](./rust-hello-world/README.md)
+| Example | Description |
-  - This example demonstrates how to write a simple RIOT application in Rust.
+|---------|-------------|
-- [rust-gcoap](./rust-gcoap/README.md)
+| [rust-hello-world](./rust-hello-world/README.md) | This example demonstrates how to write a simple RIOT application in Rust. |
-  - This example demonstrates how to write a coap server application in Rust using the RIOTs gcoap module.
+| [rust-gcoap](./rust-gcoap/README.md) | This example demonstrates how to write a coap server application in Rust using the RIOTs gcoap module. |
-- [rust-async](./rust-async/README.md)
+| [rust-async](./rust-async/README.md) | This example demonstrates how to use Rusts async/await syntax in a RIOT application. |
-  - This example demonstrates how to use Rusts async/await syntax in a RIOT application.
 
 ##### _C++_
 
-- [riot_and_cpp](./riot_and_cpp/README.md)
+| Example | Description |
-  - Example of using C++ in RIOT applications.
+|---------|-------------|
+| [riot_and_cpp](./riot_and_cpp/README.md) | Example of using C++ in RIOT applications. |
 
 #### Community Supported
 
-- [javascript](./javascript/README.md)
+| Example | Description |
-  - How to write IoT applications using javascript using JerryScript.
+|---------|-------------|
-- [lua_basic](./lua_basic/README.md)
+| [javascript](./javascript/README.md) | How to write IoT applications using javascript using JerryScript. |
-  - How to write IoT applications using Lua.
+| [lua_basic](./lua_basic/README.md) | How to write IoT applications using Lua. |
-- [lua_REPL](./lua_REPL/README.md)
+| [lua_REPL](./lua_REPL/README.md) | This example demonstrates how to use the Lua Read-Eval-Print Loop (REPL) in RIOT. |
-  - This example demonstrates how to use the Lua Read-Eval-Print Loop (REPL) in RIOT.
+| [micropython](./micropython/README.md) | How to use the MicroPython port for RIOT. |
-- [micropython](./micropython/README.md)
+| [wasm](./wasm/README.md) | How to use WebAssembly in RIOT. |
-  - How to use the MicroPython port for RIOT.
+| [arduino_hello-world](./arduino_hello-world/README.md) | This application demonstrates the usage of Arduino sketches in RIOT. |
-- [wasm](./wasm/README.md)
-  - How to use WebAssembly in RIOT.
-- [arduino_hello-world](./arduino_hello-world/README.md)
-  - This application demonstrates the usage of Arduino sketches in RIOT.
 
 ## Networking
 
 ### Constraint Application Protocol (CoAP)
 
-- [gcoap](./gcoap/README.md)
+| Example | Description |
-  - This example demonstrates the usage of the `gcoap` module, a high-level API for CoAP (Constrained Application Protocol) messaging.
+|---------|-------------|
-- [gcoap_block_server](./gcoap_block_server/README.md)
+| [gcoap](./gcoap/README.md) | This example demonstrates the usage of the `gcoap` module, a high-level API for CoAP (Constrained Application Protocol) messaging. |
-  - CoAP server handling for Block requests, build with gcoap using nanocoap block handling functions.
+| [gcoap_block_server](./gcoap_block_server/README.md) | CoAP server handling for Block requests, build with gcoap using nanocoap block handling functions. |
-- [gcoap_fileserver](./gcoap_fileserver/README.md)
+| [gcoap_fileserver](./gcoap_fileserver/README.md) | This example demonstrates the usage of the `gcoap` module to serve files over CoAP. |
-  - This example demonstrates the usage of the `gcoap`
+| [gcoap_dtls](./gcoap_dtls/README.md) | This example demonstrates the usage of the `gcoap` module with DTLS. |
-    module to serve files over CoAP.
+| [nanocoap_server](./nanocoap_server/README.md) | This example demonstrates the usage of the `nanocoap` module, a high-level API for CoAP (Constrained Application Protocol) messaging. |
-- [gcoap_dtls](./gcoap_dtls/README.md)
-  - This example demonstrates the usage of the `gcoap` module with DTLS.
-- [nanocoap_server](./nanocoap_server/README.md)
-  - This example demonstrates the usage of the `nanocoap` module, a high-level API for CoAP (Constrained Application Protocol) messaging.
 
 ### Bluetooth Low Energy (BLE)
 
 #### NimBLE
 
-- [nimble_scanner](./nimble_scanner/README.md)
+| Example | Description |
-  - This example showcases the usage of the `NimBLE` BLE stack as a scanner.
+|---------|-------------|
-- [nimble_gatt](./nimble_gatt/README.md)
+| [nimble_scanner](./nimble_scanner/README.md) | This example showcases the usage of the `NimBLE` BLE stack as a scanner. |
-  - This example application configures and runs the NimBLE BLE stack as simple GATT
+| [nimble_gatt](./nimble_gatt/README.md) | This example application configures and runs the NimBLE BLE stack as simple GATT server. |
-    server.
+| [nimble_heart_rate_sensor](./nimble_heart_rate_sensor/README.md) | This example demonstrates how to implement asynchronous data transfer using GATT notifications by implementing a mock-up BLE heart rate sensor. |
-- [nimble_heart_rate_sensor](./nimble_heart_rate_sensor/README.md)
-  - This example demonstrates how to implement asynchronous data transfer using GATT
-    notifications by implementing a mock-up BLE heart rate sensor.
-- [nimble_heart_rate_sensor](./nimble_heart_rate_sensor/README.md)
-  - This example demonstrates how to implement asynchronous data transfer using GATT
-    notifications by implementing a mock-up BLE heart rate sensor.
 
 #### Misc BLE Examples
 
-- [skald_eddystone](./skald_eddystone/README.md)
+| Example | Description |
-  - This example demonstrates the usage of `Skald` for creating an Google `Eddystone` beacon.
+|---------|-------------|
-- [skald_ibeacon](./skald_ibeacon/README.md)
+| [skald_eddystone](./skald_eddystone/README.md) | This example demonstrates the usage of `Skald` for creating an Google `Eddystone` beacon. |
-  - This example demonstrates the usage of `Skald` for creating an Apple `iBeacon`.
+| [skald_ibeacon](./skald_ibeacon/README.md) | This example demonstrates the usage of `Skald` for creating an Apple `iBeacon`. |
 
 ### MQTT
 
-- [asymcute_mqttsn](./asymcute_mqttsn/README.md)
+| Example | Description |
-  - This application demonstrates the usage of the Asymcute (MQTT-SN) module in RIOT.
+|---------|-------------|
-- [emcute_mqttsn](./emcute_mqttsn/README.md)
+| [asymcute_mqttsn](./asymcute_mqttsn/README.md) | This application demonstrates the usage of the Asymcute (MQTT-SN) module in RIOT. |
-  - This application demonstrates the usage of the emCute (MQTT-SN) module in RIOT.
+| [emcute_mqttsn](./emcute_mqttsn/README.md) | This application demonstrates the usage of the emCute (MQTT-SN) module in RIOT. |
-- [paho-mqtt](./paho-mqtt/README.md)
+| [paho-mqtt](./paho-mqtt/README.md) | This example demonstrates the usage of the Paho MQTT client library in RIOT. |
-  - This example demonstrates the usage of the Paho MQTT client library in RIOT.
 
 ### CoRE Resource Directory
 
-- [cord_ep](./cord_ep/README.md)
+| Example | Description |
-  - Example of RIOT's Resource Directory (RD) endpoint module, called `cord_ep`
+|---------|-------------|
-- [cord_lc](./cord_lc/README.md)
+| [cord_ep](./cord_ep/README.md) | Example of RIOT's Resource Directory (RD) endpoint module, called `cord_ep` |
-  - Example of RIOT's Resource Directory (RD) lookup module, called `cord_lc`
+| [cord_lc](./cord_lc/README.md) | Example of RIOT's Resource Directory (RD) lookup module, called `cord_lc` |
-- [cord_epsim](./cord_epsim/README.md)
+| [cord_epsim](./cord_epsim/README.md) | This example shows how a node can register with a CoRE resource directory |
-  - This example shows how a node can register with a CoRE resource directory
 
 ### GNRC Networking
 
-- [gnrc_minimal](./gnrc_minimal/README.md)
+| Example | Description |
-  - This is a minimalistic example for RIOT's gnrc network stack.
+|---------|-------------|
-- [gnrc_networking](./gnrc_networking/README.md)
+| [gnrc_minimal](./gnrc_minimal/README.md) | This is a minimalistic example for RIOT's gnrc network stack. |
-  - This example demonstrates the usage of the GNRC network stack in RIOT.
+| [gnrc_networking](./gnrc_networking/README.md) | This example demonstrates the usage of the GNRC network stack in RIOT. |
-- [gnrc_networking_subnets](./gnrc_networking_subnets/README.md)
+| [gnrc_networking_subnets](./gnrc_networking_subnets/README.md) | This example demonstrates IPv6 subnet auto-configuration for networks on a tree topology. |
-  - This example demonstrates IPv6 subnet auto-configuration for networks on
+| [gnrc_border_router](./gnrc_border_router/README.md) | Example of `gnrc_border_router` using automatic configuration |
-    a tree topology.
+| [gnrc_lorawan](./gnrc_lorawan/README.md) | Send and receive LoRaWAN packets and perform basic LoRaWAN commands |
-- [gnrc_border_router](./gnrc_border_router/README.md)
+| [gnrc_networking_mac](./gnrc_networking_mac/README.md) | This example shows you how to try out communications between RIOT instances with duty-cycled MAC layer protocols |
-  - Example of `gnrc_border_router` using automatic configuration
-- [gnrc_lorawan](./gnrc_lorawan/README.md)
-  - Send and receive LoRaWAN packets and perform basic LoRaWAN commands
-- [gnrc_networking_mac](./gnrc_networking_mac/README.md)
-  - This example shows you how to try out communications between RIOT instances with duty-cycled MAC layer protocols
 
 ### DTLS
 
-- [dtls-sock](./dtls-sock/README.md)
+| Example | Description |
-  - This example shows how to use DTLS sock `sock_dtls_t`
+|---------|-------------|
-- [dtls-echo](./dtls-echo/README.md)
+| [dtls-sock](./dtls-sock/README.md) | This example shows how to use DTLS sock `sock_dtls_t` |
-  - This example shows how to use TinyDTLS with sock_udp.
+| [dtls-echo](./dtls-echo/README.md) | This example shows how to use TinyDTLS with sock_udp. |
-- [dtls-wolfssl](./dtls-wolfssl/README.md)
+| [dtls-wolfssl](./dtls-wolfssl/README.md) | This example demonstrates the usage of the DTLS module with the wolfSSL library. |
-  - This example demonstrates the usage of the DTLS module with the wolfSSL library.^
 
 ### Misc
 
-<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< Updated upstream
-- [lorawan](./lorawan/README.md)
-  - This application shows a basic LoRaWAN use-case with RIOT.
-- [openthread](./openthread/README.md)
-  - This example demonstrates the usage of the OpenThread stack in RIOT.
-- [lwm2m](./lwm2m/README.md)
-  - Example of a LWM2M client on RIOT
-- [ccn-lite-relay](./ccn-lite-relay/README.md)
-  - This application demonstrates how to use the Content-Centric Networking stack
-    from [CCN-Lite](http://www.ccn-lite.net/) on RIOT
-- [telnet_server](./telnet_server/README.md)
-  - Simple telnet server that listens on port 23 over IPv6.
-- [posix_sockets](./posix_sockets/README.md)
-  - Showcase for RIOT's POSIX socket support
-- [spectrum-scanner](./spectrum-scanner/README.md)
-  - This example demonstrates how to monitor energy levels on all available wireless channels
-- [sniffer](./sniffer/README.md)
-  - This application is built to run together with the script `./tools/sniffer.py`
-    as a sniffer for (wireless) data traffic.
-- [benckmark_udp](./benchmark_udp/README.md)
-  - This example uses the `benchmark_udp` module to create a stress-test for the RIOT network stack.
-====================================================================================================
 | Example | Description |
 |---------|-------------|
 | [lorawan](./lorawan/README.md) | This application shows a basic LoRaWAN use-case with RIOT. |
@@ -181,33 +126,18 @@ Here is a quick overview of the examples available in the RIOT:
 | [sniffer](./sniffer/README.md) | This application is built to run together with the script `./tools/sniffer.py` as a sniffer for (wireless) data traffic. |
 | [benckmark_udp](./benchmark_udp/README.md) | This example uses the `benchmark_udp` module to create a stress-test for the RIOT network stack. |
 | [sock_tcp_echo](./sock_tcp_echo/README.md) | This is a simple TCP echo server / client that uses the SOCK API. |
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Stashed changes
 
 ## Advanced Examples
 
-- [bindist](./bindist/README.md)
+| Example | Description |
-  - RIOT allows for creating a "binary distribution", which can be used to ship
+|---------|-------------|
-    proprietary, compiled objects in a way that makes it possible to re-link them
+| [bindist](./bindist/README.md) | RIOT allows for creating a "binary distribution", which can be used to ship proprietary, compiled objects in a way that makes it possible to re-link them against a freshly compiled RIOT. This application serves as a simple example. |
-    against a freshly compiled RIOT. This application serves as a simple example.
+| [usbus_minimal](./usbus_minimal/README.md) | This is a minimalistic example for RIOT's USB stack. |
-- [usbus_minimal](./usbus_minimal/README.md)
+| [suit_update](./suit_update/README.md) | This example shows how to integrate SUIT-compliant firmware updates into a RIOT application. |
-  - This is a minimalistic example for RIOT's USB stack.
+| [thread_duel](./thread_duel/README.md) | This is a thread duel application to show RIOTs abilities to run multiple-threads concurrently, even if they are neither cooperative nor dividable into different scheduler priorities, by using the optional round-robin scheduler module. |
-- [suit_update](./suit_update/README.md)
+| [posix_select](./posix_select/README.md) | This example is a showcase for RIOT's POSIX select support |
-  - This example shows how to integrate SUIT-compliant firmware updates into a
+| [psa_crypto](./psa_crypto) | Basic functions of the PSA Crypto API |
-    RIOT application.
+| [pio_blink](./pio_blink/README.md) | How to use the PIO peripheral on the RaspberryPi Pico to blink an LED. |
-- [thread_duel](./thread_duel/README.md)
+| [twr_aloha](./twr_aloha/README.md) | This example allows testing different two-way ranging algorithms between two boards supporting a dw1000 device. This makes use of the uwb-core pkg. |
-  - This is a thread duel application to show RIOTs abilities to run multiple-threads
+| [senml_saul](./senml_saul/README.md) | This example demonstrates the usage of the SAUL (Sensor Actuator Uber Layer) module with the SenML (Sensor Measurement Lists) format. |
-    concurrently, even if they are neither cooperative nor dividable into different scheduler priorities, by using the optional round-robin scheduler module.
+| [opendsme](./opendsme/README.md) | This example demonstrates the usage of the OpenDSME module in RIOT. |
-- [posix_select](./posix_select/README.md)
-  - This example is a showcase for RIOT's POSIX select support
-- [psa_crypto](./psa_crypto)
-  - Basic functions of the PSA Crypto API
-- [pio_blink](./pio_blink/README.md)
-  - How to use the PIO peripheral on the RaspberryPi Pico to blink an LED.
-- [twr_aloha](./twr_aloha/README.md)
-  - This example allows testing different two-way ranging algorithms between
-    two boards supporting a dw1000 device. This makes use of the uwb-core
-    pkg.
-- [senml_saul](./senml_saul/README.md)
-  - This example demonstrates the usage of the SAUL (Sensor Actuator Uber Layer) module with the SenML (Sensor Measurement Lists) format.
-- [opendsme](./opendsme/README.md)
-  - This example demonstrates the usage of the OpenDSME module in RIOT.