Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit ce0a401

Browse files
committedMar 26, 2021
[wip] Update all docs
1 parent dd490a5 commit ce0a401

10 files changed

+673
-494
lines changed
 

‎CONTRIBUTING.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ We recommend prefixing your branch with
1313
- `fix/` for a bug fix.
1414

1515
Please remember to have a look at [our coding conventions](docs/coding_convention.md).
16+
Note that we have a `.clang-format` in the repository that can help you.
1617

1718
Once you [open the pull request][pulls], we will review it and might ask you for
18-
changes. Remember that you can continue to push to your `feature/*` or `fix/*`
19+
changes. Remember that you can continue to push to your `feature/*` or `fix/*`
1920
branches to update the corresponding pull requests!
2021

2122
Including unit tests is very welcomed and highly recommended. modm has its own
2223
simple and easy to use unit test framework. Unit tests are placed in the `modm/test`
23-
subdirectory. [See testing strategies in modm](docs/TESTING.md).
24+
subdirectory. [See testing strategies in modm](test/README.md).
2425

2526
The CI first compiles all examples and unittests and then executes the unittests
2627
for Linux. If all of that passes, it will compile all `:platform:**` modules for
@@ -30,13 +31,13 @@ CI tests in order to be merged.
3031

3132
## When in doubt, ask
3233

33-
The dedicated maintainer of modm is [@salkinium](https://github.com/salkinium)
34-
and you can always ping him.
34+
The dedicated maintainers of modm are [@salkinium](https://github.com/salkinium)
35+
and [@rleh](https://github.com/rleh) and you can always ping them.
3536

3637
If you want to add a new platform, or other significant functionality, we
3738
[ask you to discuss that in an issue first][issues]. We are very open to new
3839
helping hands, but all of this is still fairly complicated and we want to
39-
provideyou with tips and additional explanations along the way.
40+
provide you with tips and additional explanations along the way.
4041

4142
Communication is cheap, implementation is expensive and we don't want to
4243
frustrate you.

‎README.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ process that you can fine-tune to your needs.
1313

1414
<!--webignore-->
1515
- [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].
1819
- Our CI checks every contribution for regressions.
1920
- We care [about testing modm][testing].
2021
- [API reference is available here][api-docs].
@@ -53,16 +54,16 @@ git clone --recurse-submodules --jobs 8 https://github.com/modm-io/modm.git
5354
- Build system agnostic: Choose SCons, CMake or use your own.
5455
- Data-driven, target-specific HAL generation using the lbuild engine.
5556
- 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:
5859
- GPIO and GPIO expanders.
5960
- ADC and Analog.
6061
- UART, I<sup>2</sup>C, SPI, CAN.
6162
- Interfaces and drivers for many external I<sup>2</sup>C and SPI sensors and devices.
6263
- Debug/logging system with IOStream and printf interface.
6364
- Lightweight, stackless threads and resumable functions using cooperative multitasking.
6465
- 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.
6667
- Useful filter, interpolation and geometric algorithms.
6768
- Lightweight unit testing system (suitable for AVRs).
6869
- 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
9899
(★★★★★).
99100

100101
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.
104104

105105

106106
### Boards
@@ -286,7 +286,8 @@ See [CONTRIBUTING.md][contrib] for our contribution guidelines.
286286

287287
<!--authors-->
288288
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
290291
Sascha Schade ([\@strongly-typed](https://github.com/strongly-typed)),
291292
Fabian Greif ([\@dergraaf](https://github.com/dergraaf)),
292293
Kevin Läufer ([\@ekiwi](https://github.com/ekiwi)),
@@ -340,16 +341,17 @@ and <!--authorcount-->33<!--/authorcount--> more contributors.
340341
[drivers]: https://github.com/modm-io/modm/tree/develop/src/modm/driver
341342
[eurobot]: https://www.eurobot.org/
342343
[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
344346
[install]: https://modm.io/guide/installation
345347
[issues]: https://github.com/modm-io/modm/issues
346348
[library-builder]: https://github.com/dergraaf/library-builder
347349
[modm-devices]: https://github.com/modm-io/modm-devices
348350
[porting]: https://github.com/modm-io/modm/tree/develop/docs/PORTING.md
349351
[prs]: https://github.com/modm-io/modm/pulls
350352
[rca_ev]: https://www.roboterclub.rwth-aachen.de/
351-
[reference]: https://modm.io/reference/api
353+
[reference]: https://modm.io/reference/documentation
352354
[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
354356
[api-docs]: https://docs.modm.io/
355357
<!--/links-->

‎docs/mkdocs.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,10 @@ nav:
7171
- Who we are: who-we-are.md
7272
- Guide:
7373
- Installation: guide/installation.md
74-
- Exploring Examples: guide/examples.md
75-
- Your own Project: guide/new-project.md
76-
- Testing: guide/testing.md
74+
- Explore Examples: guide/examples.md
75+
- Discover modm: guide/discover.md
76+
- Your Project: guide/custom-project.md
77+
# - Testing: guide/testing.md
7778
- Reference:
7879
- Documentation: reference/documentation.md
7980
- Build Systems: reference/build-systems.md

0 commit comments

Comments
 (0)
Please sign in to comment.