readme-gen
starsforks
How to install readme-gen?
lightpointventures/claude-code-starter/readme-gen
$npx -y skills add lightpointventures/claude-code-starter --skill readme-gen当用户想写 README、生成项目文档、补充项目说明时使用 — 自动从代码中提取生成专业 README
SKILL.md
| 1 | # 生成 README |
| 2 | |
| 3 | 帮用户为项目自动生成一份专业的 README 文档。 |
| 4 | |
| 5 | ## 步骤 |
| 6 | |
| 7 | ### 1. 分析项目 |
| 8 | |
| 9 | 自动读取项目中的关键文件： |
| 10 | - package.json / pyproject.toml / go.mod → 项目名、描述、依赖 |
| 11 | - 项目目录结构 → 了解项目组成 |
| 12 | - CLAUDE.md → 项目描述和技术栈信息 |
| 13 | - 已有 README → 保留有价值的内容 |
| 14 | |
| 15 | ### 2. 提问补充 |
| 16 | |
| 17 | > 有几个信息需要确认： |
| 18 | > 1. 一句话描述这个项目（如果还没有的话） |
| 19 | > 2. 项目目前是什么状态？（开发中 / 可用 / 稳定） |
| 20 | > 3. README 用中文还是英文？ |
| 21 | |
| 22 | ### 3. 生成 README |
| 23 | |
| 24 | 生成包含以下部分的 README.md： |
| 25 | |
| 26 | - **项目标题和描述** — 简洁有力的一句话 |
| 27 | - **功能特性** — 项目核心功能的要点列表 |
| 28 | - **快速开始** — 安装和运行的最少步骤 |
| 29 | - **使用方法** — 基本用法和示例 |
| 30 | - **技术栈** — 使用的主要技术 |
| 31 | - **项目结构** — 关键目录和文件说明（简洁版） |
| 32 | - **开发指南** — 如何参与开发（如果需要） |
| 33 | - **License** — 许可证信息 |
| 34 | |
| 35 | 规则： |
| 36 | - 内容从项目实际代码中提取，不要编造功能 |
| 37 | - 安装步骤要准确可执行 |
| 38 | - 保持简洁，不要把 README 写成文档站 |
| 39 | |
| 40 | ### 4. 确认 |
| 41 | |
| 42 | 展示生成的内容，用户确认后写入。 |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
