name: readme-generator
description: 自动生成简洁、视觉惊艳的README.md，具有项目自动扫描、徽章和3种样式模式。
README生成器 v2
目的
生成简洁、可扫描的README文件，在GitHub上看起来高级。自动检测项目上下文并生成徽章、功能和安装说明。
设计哲学
- 扫描，不阅读 — 使用表格、徽章、一行描述替代段落
- 视觉优先 — 居中对齐的英雄部分、shields.io徽章、表情符号标题
- 无文本墙 — 每个部分最多2-3句，使用表格/项目符号
- 智能检测 — 自动读取
package.json、setup.py、VERSION、.agent/以填充真实数据
使用
自动生成（推荐）
# 扫描项目并生成README
python .agent/skills/readme-generator/scripts/readme_gen.py --path .
# 使用特定样式
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style minimal
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style standard # 默认
python .agent/skills/readme-generator/scripts/readme_gen.py --path . --style detailed
自定义字段
python .agent/skills/readme-generator/scripts/readme_gen.py \
--path . \
--name "我的项目" \
--slogan "一行销售语" \
--author "用户名" \
--image "https://example.com/banner.png"
样式模式
| 模式 |
行数 |
最适合 |
minimal |
~40-60 |
库、包、简单工具 |
standard |
~80-120 |
大多数项目（默认） |
detailed |
~120-180 |
复杂框架、多组件项目 |
自动检测内容
| 来源 |
提取内容 |
package.json |
名称、版本、许可证、脚本、依赖项 |
setup.py / pyproject.toml |
名称、版本、许可证、依赖项 |
VERSION |
版本号 |
LICENSE |
许可证类型 |
.agent/skills/ |
技能数量 |
.agent/workflows/ |
工作流/代理数量 |
Dockerfile |
Docker支持 |
tsconfig.json |
TypeScript检测 |
关键规则
- 永不写段落 — 使用表格、项目符号或一行描述
- 英雄部分必须居中 —
<div align="center"> 包含标题 + 徽章 + 图像
- 功能在表格中 —
| 表情符号功能 | 一行描述 |
- 安装说明 ≤ 5行 — 克隆 → 安装 → 运行，无叙述
- 仅相关部分 — 如果没有Dockerfile，跳过Docker部分