ratatui/mousefood

Add setup information for the examples

オープン

#170 opened on 2026/02/21

 (7 件のコメント) (0 件のリアクション) (0 人の担当者)Rust (40 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,296 個のスター)
PR merge metrics
 (平均マージ 10h 35m) (30d で 9 merged PRs)

説明

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

コントリビューターガイド