Menu
Generate a standardized README.md for an ESP32 project by analyzing source code, justfile, and hardware configuration
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Debug static, hiss, or noise on embedded I2S audio (ESP32 + MAX98357A / PCM DACs), especially streamed PCM. Measure the signal at each pipeline stage instead of guessing at the amp. Use when audio plays but sounds wrong.
Generate a printable Typst build guide (source + PDF) for an ESP32/MCU project by analyzing its docs, source, and schematic
Register a project in the monorepo — justfile mod, CI matrix, standard file inventory
Standardize credential handling for an ESP32 project (credentials.h.example, .gitignore, pre-commit protection)
Set up ESP-IDF development environment, create new projects, and verify configuration
Generate a CLAUDE.md for a project with build commands, hardware constraints, architecture, and development tasks
| name | project-readme |
| description | Generate a standardized README.md for an ESP32 project by analyzing source code, justfile, and hardware configuration |
| argument-hint | <project-path> |
| user-invocable | true |
| allowed-tools | Read, Write, Edit, Grep, Glob, Agent |
Generate or update a README.md for the project at $1 (relative path under packages/<domain>/).
Read the project source to understand its purpose and capabilities:
main/*.c, main/*.h — functionality, peripherals, protocolsmain/CMakeLists.txt — component dependenciessdkconfig.defaults — target chip, enabled featuresjustfile — available build/flash/monitor recipesCLAUDE.md — existing project description (if present)WIRING.md — hardware connections (if present)Kconfig.projbuild — configurable optionsIdentify the board and key features (WiFi, Bluetooth, camera, sensors, etc.)
Generate README.md following the template below
# <Project Name>
<One paragraph description: what this project does, what hardware it targets, and its key capability.>
## Hardware
- **Board**: <board name and variant>
- **Peripherals**: <list of connected hardware>
For detailed wiring instructions, see [WIRING.md](WIRING.md).
## Quick Start
### Prerequisites
- Docker (for containerized builds)
- USB cable for flashing
### Build and Flash
```bash
just <module>::build # Build firmware
just <module>::flash # Flash to device
just <module>::monitor # Serial monitor
just <module>::develop # Build + flash + monitor
<Describe any required configuration: credentials.h, sdkconfig options, Kconfig choices.>
<Brief description of how the firmware is structured: main loop, tasks, state machine, communication protocols.>
<project-name>/
├── main/
│ ├── main.c — <brief description>
│ └── ...
├── justfile — Build recipes
├── sdkconfig.defaults — ESP-IDF configuration
└── CMakeLists.txt — CMake project definition
## Style Rules
- **Concise** — target 50-100 lines, not 300
- **Actionable** — lead with Quick Start so users can build immediately
- **No generic ESP32 tutorials** — only project-specific information
- **Link to WIRING.md** for hardware details rather than duplicating pin tables
- **Link to CLAUDE.md** if it exists for developer-focused details
- **Use actual justfile recipe names** — read the justfile to get the correct module name and recipes
- **Include credential setup** if the project uses WiFi/API keys