用途
readme-generator 是一个面向 Arduino、ESP32、RP2040 等创客（maker）项目的 README 生成技能，用于自动生成专业、对初学者友好的 README.md 文件。它适合在用户需要为项目撰写文档、准备把项目发布到 GitHub、希望项目更易于分享，或项目已经可用但缺少文档时使用。该技能参考 awesome-readme 标准组织章节，覆盖 Overview、Hardware、Software、Setup、Usage、Troubleshooting、Contributing 等内容。
主要能力
- 生成完整 README 结构，包含徽章（badges）、目录（Table of Contents）、概览、功能列表、硬件组件表、接线图说明、软件依赖表、安装步骤、配置说明、使用说明、故障排查、贡献指南、许可证与致谢等章节。
- 提供捆绑脚本
scripts/generate_readme.py，支持生成接线图（wiring diagrams）与使用模板。 - 支持自动从代码中提取信息：从 config.h 提取引脚分配（pin assignments）、库引用（library includes）、WiFi/蓝牙功能、传感器类型。
- 提供信息收集清单，指导向用户询问项目名称与一句话描述、解决的问题、主要功能、硬件组件、软件库、可用的照片/视频/GIF、许可证偏好（推荐 MIT）、目标读者等。
- 提供章节写作规范与好坏示例，帮助撰写清晰的项目描述、功能与安装步骤。
- 提供视觉素材建议（项目照片、接线图、演示 GIF、原理图）以及 GIF 制作与优化建议。
- 提供徽章示例（状态、版本、许可证、平台、社交）与推荐文件结构。
- 提供发布前 README 检查清单，包括链接、拼写、许可证文件、联系方式等检查项。
使用方式
该技能包含一个 Python 脚本，可通过 uv 运行。
交互模式：
uv run --no-project scripts/generate_readme.py --interactive
快速生成：
uv run --no-project scripts/generate_readme.py --project "Weather Station" --board "ESP32" --output README.md
扫描现有项目：
uv run --no-project scripts/generate_readme.py --scan /path/to/arduino/project --output README.md
生成文档时会按模板输出 Markdown 结构，其中包含硬件组件表、引脚连接表、软件依赖表、config.h 配置示例、LED 状态指示表、串口监视器输出示例、Web 界面说明以及故障排查折叠段落等内容。
适用场景
- 用户说“帮我给这个项目写文档”“我想把它分享到 GitHub”“为我的项目写一个 README”。
- 用户已有可运行的项目，但需要文档。
- 在发布到 GitHub 或 Instructables 之前整理项目说明。
- 需要按照 awesome-readme 标准生成结构统一的 README。
限制与说明
- 生成的文档内容依赖用户提供或从代码中提取的信息；资料中未说明是否存在联网或云端服务。
- 资料中未提供该技能的收费、价格、平台支持范围、生成效果保证等信息。
- 该技能面向 Arduino/ESP32/RP2040 等创客项目文档，不涉及其他类型的文档写作。