Skip to content

Commit f381b40

Browse files
committed
[examples] Update documentation
1 parent a3edeaf commit f381b40

File tree

3 files changed

+76
-20
lines changed

3 files changed

+76
-20
lines changed

examples/README.md

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Change directory into any of the examples and compile it:
1818

1919
```sh
2020
# cd into any example you like
21-
cd modm/examples/generic/blinky
21+
cd modm/examples/core/blinky
2222
# generate modm library (call only once)
2323
lbuild build
2424
# compile the example
@@ -56,6 +56,69 @@ Have a look at the [build system documentation][build_docs] and the
5656
[online documentation][docs].
5757

5858

59+
## Structure
60+
61+
- core
62+
- custom_allocator
63+
- delay
64+
- exceptions_rtti
65+
- fiber
66+
- flash
67+
- hard_fault
68+
- itm
69+
- multi-core
70+
- resumable
71+
- rtt
72+
- threadsafe_statics
73+
- tlsf_allocator
74+
- unaligned_access
75+
- vector_table_ram
76+
- gpio
77+
- blinky
78+
- exti
79+
- gpio
80+
- ports
81+
- analog
82+
- adc_dma
83+
- comp
84+
- dac
85+
- timer
86+
- encoder_input
87+
- pwm
88+
- timer
89+
- logging
90+
- logger
91+
- printf
92+
- uart
93+
- ui
94+
- game_of_life
95+
- graphics
96+
- lvgl
97+
- driver
98+
- can
99+
- i2c
100+
- single wire
101+
- spi
102+
- communication
103+
- amnb
104+
- ethernet_freertos
105+
- nrf24
106+
- ros
107+
- sab
108+
- xpcc
109+
- ext
110+
- cmsis_dsp
111+
- etl
112+
- freertos
113+
- nanopb
114+
- usb
115+
- usb_dfu
116+
- usbfatfs
117+
- board
118+
- super custom board-specific examples
119+
- ideally we get rid of this section
120+
121+
59122
## Interesting Examples
60123

61124
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:
117180
<!--/checkrepourls-->
118181

119182

183+
<!--webignore-->
184+
### Compiling Examples for Multiple Targets
185+
186+
187+
<!--/webignore-->
188+
120189
### Copy Carefully
121190

122191
When copying from our examples make sure to set the repository path correctly!
@@ -134,10 +203,10 @@ The `modm/examples/lbuild.xml` file:
134203
When you write your own application, you must set this
135204
path yourself! -->
136205
<repositories>
137-
<repository><path>../repo.lb</path></repository>
206+
<repository><path>../repo.lb</path></repository>
138207
</repositories>
139208
<modules>
140-
<module>modm:docs</module>
209+
<module>modm:docs</module>
141210
</modules>
142211
</library>
143212
```

examples/generic/README.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

examples/generic/delay/project.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,21 @@
1313
<!-- <extends>modm:nucleo-f446re</extends> -->
1414
<!-- <extends>modm:nucleo-g071rb</extends> -->
1515
<!-- <extends>modm:nucleo-h743zi</extends> -->
16-
<extends>modm:nucleo-l152re</extends>
16+
<!-- <extends>modm:nucleo-l152re</extends> -->
1717
<!-- <extends>modm:nucleo-l432kc</extends> -->
1818
<!-- <extends>modm:nucleo-l476rg</extends> -->
19-
<!-- <extends>modm:samd21-mini</extends> -->
2019
<!-- <extends>modm:rp-pico</extends> -->
20+
<!-- <extends>modm:samd21-mini</extends> -->
2121
<options>
2222
<option name="modm:io:with_printf">true</option>
23+
<!-- Required for modm:samd21-mini, modm:rp-pico -->
2324
<!-- <option name="modm:tinyusb:config">device.cdc</option> -->
2425
</options>
2526
<modules>
2627
<module>modm:build:scons</module>
2728
<module>modm:debug</module>
2829
<module>modm:driver:cycle_counter</module>
30+
<!-- Required for modm:samd21-mini, modm:rp-pico -->
2931
<!-- <module>modm:tinyusb</module> -->
3032
</modules>
3133
</library>

0 commit comments

Comments
 (0)