ratatui/mousefood

Add setup information for the examples

开放

#170 创建于 2026年2月21日

 (7 条评论) (0 个反应) (0 位负责人)Rust (40 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (1,296 个星标)
PR 合并指标
 (平均合并 10小时 35分钟) (30 天内合并 9 个 PR)

描述

The examples currently lack the setup information which makes hard to adopt with similar boards. We should add a respective README.md for each one, preferably in the same format. I'm thinking:

# <name of the example>

<a small description>

## Pinmap

<pinout image of the board (find it from the internet)>

<markdown table of pins>

## Wiring

<some image,text or mermaid diagram>

## Notes

<other related info>

For example:


# ESP32 no-std demo

This example showcases .....

## Pinmap

| Function      | ESP32 pin | Notes                                |
| ------------- | --------- | ------------------------------------ |
| LCD backlight | `GPIO4`   | Set high to enable backlight         |
| SPI SCK       | `GPIO18`  | ST7789 clock                         |
| SPI MOSI      | `GPIO19`  | ST7789 data                          |

## Wiring

```mermaid
flowchart LR
etc
```

## Notes

Pls set your display size

Checklist

贡献者指南