Skip to content

Commit

Permalink
[examples] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
salkinium committed Apr 12, 2024
1 parent a3edeaf commit f381b40
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 20 deletions.
75 changes: 72 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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!
Expand All @@ -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>
```
Expand Down
15 changes: 0 additions & 15 deletions examples/generic/README.md

This file was deleted.

6 changes: 4 additions & 2 deletions examples/generic/delay/project.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>

0 comments on commit f381b40

Please sign in to comment.