用途:为指定路径下的 ESP32 项目生成或更新 README.md,依据源码与配置自动整理项目说明。
主要能力:会读取 main/.c、main/.h(功能、外设、协议)、main/CMakeLists.txt(组件依赖)、sdkconfig.defaults(目标芯片、启用特性)、justfile(构建/烧录/监视配方)、CLAUDE.md、WIRING.md 以及 Kconfig.projbuild,据此识别开发板与 WiFi、蓝牙、摄像头、传感器等关键特性,再按模板生成 README.md。
模板结构:项目名与一段描述、Hardware(Board、Peripherals,并链接 WIRING.md)、Quick Start(前置条件含 Docker 与 USB 线,命令 just <module>::build、just <module>::flash、just <module>::monitor、just <module>::develop)、Configuration(credentials.h、sdkconfig 选项、Kconfig 选择)、Architecture(主循环、任务、状态机、通信协议)、Project Structure(目录树)。
风格要求:简洁,控制在 50-100 行;以 Quick Start 开头便于立即构建;只写项目专属信息,不写通用 ESP32 教程;硬件细节链接 WIRING.md;存在 CLAUDE.md 时链接给开发者;使用 justfile 中真实的模块名与配方名;若项目使用 WiFi 或 API 密钥,需包含凭据配置说明。
适用场景:基于 ESP-IDF 的 ESP32 项目,且以 justfile 作为构建入口,希望统一 README 格式。
限制:面向 packages/<domain>/ 下的相对路径项目;需存在相应源码与配置才能分析;具体安装、收费与平台支持暂未提供。