Skip to content

Commit 0b45225

Browse files
committed
1.0.8
1 parent 2b589f0 commit 0b45225

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ mcu-renderer is a lightweight C graphics library designed for microcontrollers (
3030
- Hardware-specific development tools (e.g., SDKs for ST7789, ILI9341, or ST7565).
3131
- SDL library for PC testing (optional).
3232

33-
## Quick Start
33+
## Quick start
3434

3535
1. **Include the library**: Add the device-specific header file (see [Supported Devices](docs/supported-devices.md)).
3636
2. **Initialize the display**:
@@ -51,7 +51,7 @@ mcu-renderer is a lightweight C graphics library designed for microcontrollers (
5151
```c
5252
mr_xxx_refresh_screen();
5353
```
54-
## Setup and Usage
54+
## Setup and usage
5555

5656
1. **Initialize the library**:
5757
- Call `mr_xxx_init()` to set up the display (e.g., `mr_st7789_init()`).
@@ -94,7 +94,7 @@ mcu-renderer is a lightweight C graphics library designed for microcontrollers (
9494
- Center text horizontally using `mr_get_text_width()` (or `utf8`/`utf16` variants).
9595
- Center vertically using font metrics: `mr_get_cap_height()`, `mr_get_ascent()`, `mr_get_descent()`, or `mr_get_line_height()`.
9696

97-
5. **Refresh Screen** (Monochrome or SDL):
97+
5. **Refresh screen** (Monochrome or SDL):
9898
- Call `mr_xxx_refresh_screen()` after drawing to update the display.
9999

100100
## Font metrics
@@ -164,13 +164,13 @@ Run `textproc` to process files:
164164
python tools/textproc.py --help
165165
```
166166

167-
## Additional Resources
167+
## Additional resources
168168

169169
- [Roboto Font](https://fonts.google.com/specimen/Roboto): Ideal for embedded systems.
170170
- [Material Symbols](https://fonts.google.com/icons): Symbol font for icons.
171171
- [FontForge](https://fontforge.org/): Vector font editor.
172172
- [Bits'N'Picas](https://github.com/kreativekorp/bitsnpicas): Bitmap font editor.
173173
- [FontDrop!](https://fontdrop.info/): Online glyph viewer.
174-
- [Oh My Glyph](https://www.ohmyglyph.com/): Online glyph copy-paste tool.
175-
- [Pinetools Color Blender](https://pinetools.com/blend-colors): Online color blending tool.
176-
- [RGB565 Color Picker](https://rgbcolorpicker.com/565): Online RGB565 color selector.
174+
- [Oh my glyph](https://www.ohmyglyph.com/): Online glyph copy-paste tool.
175+
- [Pinetools color blender](https://pinetools.com/blend-colors): Online color blending tool.
176+
- [RGB565 color picker](https://rgbcolorpicker.com/565): Online RGB565 color selector.

docs/supported-devices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ mr_st7565_init(&mr, 128, 64, MR_ROTATION_0, framebuffer,
161161
mr_send_sequence(&mr, st7565_init_sequence);
162162
```
163163
164-
## Best Practices
164+
## Best practices
165165
- **Framebuffer sizing**: Ensure framebuffers meet minimum size requirements to avoid rendering issues.
166166
- **Custom initialization**: Always follow initialization calls with `mr_send_sequence()` to configure the display properly.
167167
- **Callback implementation**: Implement callbacks carefully, ensuring they interact correctly with your hardware's GPIO and communication protocols.

0 commit comments

Comments
 (0)