with one click
project-readme
Generate a standardized README.md for an ESP32 project by analyzing source code, justfile, and hardware configuration
Menu
Generate a standardized README.md for an ESP32 project by analyzing source code, justfile, and hardware configuration
| 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
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
Audit project completeness against the monorepo standard checklist (docs, config, registration)
Register a project in the monorepo ā justfile mod, CI matrix, standard file inventory
Audit sdkconfig.defaults by inferring needed settings from source code analysis