From f381b40d5b4d71c3b742ed0553a247300ea29eec Mon Sep 17 00:00:00 2001
From: Niklas Hauser <niklas.hauser@rwth-aachen.de>
Date: Sat, 6 Jan 2024 23:06:33 +0100
Subject: [PATCH] [examples] Update documentation

---
 examples/README.md                 | 75 ++++++++++++++++++++++++++++--
 examples/generic/README.md         | 15 ------
 examples/generic/delay/project.xml |  6 ++-
 3 files changed, 76 insertions(+), 20 deletions(-)
 delete mode 100644 examples/generic/README.md

diff --git a/examples/README.md b/examples/README.md
index bdec775371..3e59f97f8a 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -18,7 +18,7 @@ Change directory into any of the examples and compile it:
 
 ```sh
 # cd into any example you like
-cd modm/examples/generic/blinky
+cd modm/examples/core/blinky
 # generate modm library (call only once)
 lbuild build
 # compile the example
@@ -56,6 +56,69 @@ Have a look at the [build system documentation][build_docs] and the
 [online documentation][docs].
 
 
+## Structure
+
+- core
+  - custom_allocator
+  - delay
+  - exceptions_rtti
+  - fiber
+  - flash
+  - hard_fault
+  - itm
+  - multi-core
+  - resumable
+  - rtt
+  - threadsafe_statics
+  - tlsf_allocator
+  - unaligned_access
+  - vector_table_ram
+- gpio
+  - blinky
+  - exti
+  - gpio
+  - ports
+- analog
+  - adc_dma
+  - comp
+  - dac
+- timer
+  - encoder_input
+  - pwm
+  - timer
+- logging
+  - logger
+  - printf
+  - uart
+- ui
+  - game_of_life
+  - graphics
+  - lvgl
+- driver
+  - can
+  - i2c
+  - single wire
+  - spi
+- communication
+  - amnb
+  - ethernet_freertos
+  - nrf24
+  - ros
+  - sab
+  - xpcc
+- ext
+  - cmsis_dsp
+  - etl
+  - freertos
+  - nanopb
+  - usb
+  - usb_dfu
+  - usbfatfs
+- board
+  - super custom board-specific examples
+  - ideally we get rid of this section
+
+
 ## Interesting Examples
 
 We have hundreds of examples but here are some of our favorite ones for our
@@ -117,6 +180,12 @@ Here are some additional examples of displays and sensors we like:
 <!--/checkrepourls-->
 
 
+<!--webignore-->
+### Compiling Examples for Multiple Targets
+
+
+<!--/webignore-->
+
 ### Copy Carefully
 
 When copying from our examples make sure to set the repository path correctly!
@@ -134,10 +203,10 @@ The `modm/examples/lbuild.xml` file:
        When you write your own application, you must set this
        path yourself! -->
   <repositories>
-  	<repository><path>../repo.lb</path></repository>
+    <repository><path>../repo.lb</path></repository>
   </repositories>
   <modules>
-  	<module>modm:docs</module>
+    <module>modm:docs</module>
   </modules>
 </library>
 ```
diff --git a/examples/generic/README.md b/examples/generic/README.md
deleted file mode 100644
index 3e8db68453..0000000000
--- a/examples/generic/README.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Generic Examples for modm
-
-Over time many examples have been duplicated to many different dev boards.
-
-Up-to-date examples which run on different boards shall be consolidated
-in this folder. Typically, only the dev board in project.cfg should be
-replaced. A good example is blinky from
-https://github.com/roboterclubaachen/getting-started-with-modm
-
-# List of examples
-
-| Example            | External Hardware       | Nucleo L476RG    | Arduino Uno |
-|:-------------------|:------------------------|:-----------------|:------------|
-| Blinky( + Logger)  | None                    | &#9989;          | &#9989;     |
-| RTC DS1302         | RTC Module DS1302       | &#9989;          | &#9989;     |
diff --git a/examples/generic/delay/project.xml b/examples/generic/delay/project.xml
index 7c6303f4f1..d61d826ad1 100644
--- a/examples/generic/delay/project.xml
+++ b/examples/generic/delay/project.xml
@@ -13,19 +13,21 @@
   <!-- <extends>modm:nucleo-f446re</extends> -->
   <!-- <extends>modm:nucleo-g071rb</extends> -->
   <!-- <extends>modm:nucleo-h743zi</extends> -->
-  <extends>modm:nucleo-l152re</extends>
+  <!-- <extends>modm:nucleo-l152re</extends> -->
   <!-- <extends>modm:nucleo-l432kc</extends> -->
   <!-- <extends>modm:nucleo-l476rg</extends> -->
-  <!-- <extends>modm:samd21-mini</extends> -->
   <!-- <extends>modm:rp-pico</extends> -->
+  <!-- <extends>modm:samd21-mini</extends> -->
   <options>
     <option name="modm:io:with_printf">true</option>
+    <!-- Required for modm:samd21-mini, modm:rp-pico -->
     <!-- <option name="modm:tinyusb:config">device.cdc</option> -->
   </options>
   <modules>
     <module>modm:build:scons</module>
     <module>modm:debug</module>
     <module>modm:driver:cycle_counter</module>
+    <!-- Required for modm:samd21-mini, modm:rp-pico -->
     <!-- <module>modm:tinyusb</module> -->
   </modules>
 </library>