@@ -13,8 +13,9 @@ process that you can fine-tune to your needs.
13
13
14
14
<!-- webignore-->
15
15
- [ This project has a homepage] ( http://modm.io ) .<!-- /webignore-->
16
- - Check out our [ install instructions] [ install ] and our [ getting started guide] [ guide ] .
17
- - Feast your eyes on [ lots of working examples] [ examples ] .
16
+ - [ Install the toolchain] [ install ] and [ explore our examples] [ examples ] .
17
+ - You can [ discover the modm library] [ discover ] in more detail.
18
+ - Easily start your [ own completely custom project] [ custom-project ] .
18
19
- Our CI checks every contribution for regressions.
19
20
- We care [ about testing modm] [ testing ] .
20
21
- [ API reference is available here] [ api-docs ] .
@@ -53,16 +54,16 @@ git clone --recurse-submodules --jobs 8 https://github.com/modm-io/modm.git
53
54
- Build system agnostic: Choose SCons, CMake or use your own.
54
55
- Data-driven, target-specific HAL generation using the lbuild engine.
55
56
- No memory allocations in HAL with very low overall RAM consumption.
56
- - Highly- configurable modules with sensible defaults and lots of documentation.
57
- - Cross platform peripheral interfaces incl. bit banging:
57
+ - Highly configurable modules with sensible defaults and lots of documentation.
58
+ - Cross- platform peripheral interfaces incl. bit banging:
58
59
- GPIO and GPIO expanders.
59
60
- ADC and Analog.
60
61
- UART, I<sup >2</sup >C, SPI, CAN.
61
62
- Interfaces and drivers for many external I<sup >2</sup >C and SPI sensors and devices.
62
63
- Debug/logging system with IOStream and printf interface.
63
64
- Lightweight, stackless threads and resumable functions using cooperative multitasking.
64
65
- Functional (partial) libstdc++ implementation for AVRs.
65
- - Integration of useful third-party software: FreeRTOS, ROSserial, CMSIS-DSP.
66
+ - Integration of useful third-party software: FreeRTOS, ROSserial, CMSIS-DSP, TinyUSB .
66
67
- Useful filter, interpolation and geometric algorithms.
67
68
- Lightweight unit testing system (suitable for AVRs).
68
69
- Hundreds of tests to ensure correct functionality.
@@ -98,9 +99,8 @@ We also use a few targets in everyday development, which are very well tested
98
99
(★★★★★).
99
100
100
101
We are only a small team of developers and are limited in the amount of targets
101
- we can support and test in hardware. We have prepared, but currently not finished
102
- support for STM32F2, STM32L0 and STM32L1. [ Open an issue] [ issues ] to ask if your
103
- specific target is supported out-of-the-box and what you can do if it's not.
102
+ we can support and test in hardware. [ Open an issue] [ issues ] to ask if your
103
+ specific target is supported out-of-the-box and what you can do if it is not.
104
104
105
105
106
106
### Boards
@@ -286,7 +286,8 @@ See [CONTRIBUTING.md][contrib] for our contribution guidelines.
286
286
287
287
<!-- authors-->
288
288
The modm project is maintained by
289
- Niklas Hauser ([ \@ salkinium] ( https://github.com/salkinium ) ) with significant contributions from
289
+ Niklas Hauser ([ \@ salkinium] ( https://github.com/salkinium ) ) and
290
+ Raphael Lehmann ([ \@ rleh] ( https://github.com/rleh ) ) with significant contributions from
290
291
Sascha Schade ([ \@ strongly-typed] ( https://github.com/strongly-typed ) ),
291
292
Fabian Greif ([ \@ dergraaf] ( https://github.com/dergraaf ) ),
292
293
Kevin Läufer ([ \@ ekiwi] ( https://github.com/ekiwi ) ),
@@ -340,16 +341,17 @@ and <!--authorcount-->33<!--/authorcount--> more contributors.
340
341
[ drivers ] : https://github.com/modm-io/modm/tree/develop/src/modm/driver
341
342
[ eurobot ] : https://www.eurobot.org/
342
343
[ examples ] : https://github.com/modm-io/modm/tree/develop/examples
343
- [ guide ] : https://modm.io/guide/getting-started
344
+ [ discover ] : https://modm.io/guide/discover
345
+ [ custom-project ] : https://modm.io/guide/custom-project
344
346
[ install ] : https://modm.io/guide/installation
345
347
[ issues ] : https://github.com/modm-io/modm/issues
346
348
[ library-builder ] : https://github.com/dergraaf/library-builder
347
349
[ modm-devices ] : https://github.com/modm-io/modm-devices
348
350
[ porting ] : https://github.com/modm-io/modm/tree/develop/docs/PORTING.md
349
351
[ prs ] : https://github.com/modm-io/modm/pulls
350
352
[ rca_ev ] : https://www.roboterclub.rwth-aachen.de/
351
- [ reference ] : https://modm.io/reference/api
353
+ [ reference ] : https://modm.io/reference/documentation
352
354
[ releases ] : https://github.com/modm-io/modm/releases
353
- [ testing ] : https://modm. io/guide/testing
355
+ [ testing ] : https://github.com/modm- io/modm/tree/develop/test/README.md
354
356
[ api-docs ] : https://docs.modm.io/
355
357
<!-- /links-->
0 commit comments