project-readme

Installation
SKILL.md

Task

Generate or update a README.md for the project at $1 (relative path under packages/<domain>/).

Process

  1. Read the project source to understand its purpose and capabilities:

    • main/*.c, main/*.h — functionality, peripherals, protocols
    • main/CMakeLists.txt — component dependencies
    • sdkconfig.defaults — target chip, enabled features
    • justfile — available build/flash/monitor recipes
    • CLAUDE.md — existing project description (if present)
    • WIRING.md — hardware connections (if present)
    • Kconfig.projbuild — configurable options
  2. Identify the board and key features (WiFi, Bluetooth, camera, sensors, etc.)

  3. Generate README.md following the template below

Installs
9
GitHub Stars
6
First Seen
Apr 27, 2026
project-readme — laurigates/mcu-tinkering-lab