ratatui/mousefood

Add setup information for the examples

Open

#170 opened on Feb 21, 2026

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Rust (40 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,296 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
For each example in the examples directory, create a README.md following the provided template: include a brief description, pinmap table, wiring diagram (image or mermaid), and notes. Look for existing pinout images and wiring info online or from the hardware documentation.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80