Skip to content

Commit

Permalink
[docs] Polishing the documentation
Browse files Browse the repository at this point in the history
- Remove defunct Twitter Account.
- Fix dead links.
- Replace system overview graphic.
  • Loading branch information
salkinium committed Feb 24, 2024
1 parent 2ac6250 commit c47e7b7
Show file tree
Hide file tree
Showing 6 changed files with 144 additions and 8 deletions.
2 changes: 0 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/modm-io
- icon: fontawesome/brands/twitter
link: https://twitter.com/modm_embedded

markdown_extensions:
- markdown.extensions.admonition
Expand Down
7 changes: 3 additions & 4 deletions docs/src/how-modm-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,15 @@ specifically for your targets and needs and generate a custom library.
You can generate more than just code, in this example, lbuild also generates a
build system which then compiles and links the application into a executable.

<style scoped>@media(prefers-color-scheme:dark){img{filter:invert(100%)}}</style>
![](images/system_overview.png)
<center>
![](images/system-overview.svg)
</center>

We've also put a lot of thought into modm-devices, about what data to extract,
how to format and store it. We automated the entire process to get the high
quality data we use to build our library.
You can read all [about modm-devices in this blog post](http://blog.salkinium.com/modm-devices).

![](http://blog.salkinium.com/assets/dfg_architecture.png)


## modm is highly modular

Expand Down
31 changes: 31 additions & 0 deletions docs/src/images/system-overview.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
digraph dependencies
{
bgcolor = transparent;
rankdir = LR;
subgraph modm
{
label = "modm";
node [style=filled, shape=box];

modm_config [label="Config", style="filled,solid", fillcolor=lightsalmon];
modm_application [label="Application", style="filled,solid", fillcolor=lightsalmon, rank=1];

modm_lbuild [label="lbuild", style="filled,solid", fillcolor=lightblue];
modm_modules [label="modm", style="filled,solid,bold", fillcolor=lightblue];
modm_devices [label="Database", style="filled,solid", fillcolor=lightblue];

modm_build_system [label="Build System", style="filled,solid", fillcolor=lightgreen];
modm_custom_library [label="C++ Library", style="filled,solid", fillcolor=lightgreen];
modm_build_artifacts [label="Build Artifacts", style="filled,solid", fillcolor=lightgreen];
}
modm_config -> modm_lbuild [constraint=false];

modm_lbuild -> modm_modules;
modm_devices -> modm_modules [constraint=false];
modm_modules -> modm_build_system;
modm_modules -> modm_custom_library;

modm_application -> modm_build_system;
modm_custom_library -> modm_build_system [constraint=false];
modm_build_system -> modm_build_artifacts;
}
108 changes: 108 additions & 0 deletions docs/src/images/system-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/images/system_overview.png
Binary file not shown.
4 changes: 2 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,10 @@ Here are some additional examples of displays and sensors we like:

- [SSD1306 OLED display](https://github.com/modm-io/modm/blob/develop/examples/stm32f4_discovery/display/ssd1306/main.cpp): Draws text and graphics onto I2C display.
- [BMP085/BMP180 barometer](https://github.com/modm-io/modm/blob/develop/examples/stm32f4_discovery/barometer_bmp085_bmp180/main.cpp): Reads atmospheric pressure and temperature from I2C sensor.
- [BMP180/BME280 barometer](https://github.com/modm-io/modm/tree/develop/examples/stm32f103c8t6_blue_pill/environment): Reads atmospheric pressure and temperature from multiple I2C sensors.
- [BMP180/BME280 barometer](https://github.com/modm-io/modm/tree/develop/examples/blue_pill/environment): Reads atmospheric pressure and temperature from multiple I2C sensors.
- [VL6180 time-of-flight distance sensor](https://github.com/modm-io/modm/blob/develop/examples/stm32f4_discovery/distance_vl6180/main.cpp): Reads distance and ambient light from I2C sensor.
- [VL53L0 time-of-flight distance sensor](https://github.com/modm-io/modm/tree/develop/examples/nucleo_f401re/distance_vl53l0/main.cpp): Much improved version of the VL6180 sensor.
- [ADNS9800 motion sensor](https://github.com/modm-io/modm/tree/develop/examples/stm32f103c8t6_blue_pill/adns_9800/main.cpp): Reads 2D motion from SPI sensor used in gaming mice.
- [ADNS9800 motion sensor](https://github.com/modm-io/modm/tree/develop/examples/blue_pill/adns_9800/main.cpp): Reads 2D motion from SPI sensor used in gaming mice.
- [TCS3414 color sensor](https://github.com/modm-io/modm/blob/develop/examples/stm32f4_discovery/colour_tcs3414/main.cpp): Reads RGB color from I2C sensor.
- [HD44780 over I2C-GPIO expander](https://github.com/modm-io/modm/blob/develop/examples/stm32f4_discovery/display/hd44780/main.cpp): Draws text via native GPIO port or I2C-GPIO expander port onto character display.

Expand Down

0 comments on commit c47e7b7

Please sign in to comment.