# Readme Gen

> 当用户想写 README、生成项目文档、补充项目说明时使用 — 自动从代码中提取生成专业 README

- Skill: `lightpointventures/readme-gen` (Agent Skill)
- Install (CLI): `npx skillmds@latest add lightpointventures/readme-gen`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lightpointventures/readme-gen/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: lightpointventures (https://skillmd.com/u/lightpointventures)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lightpointventures/readme-gen

---


# 生成 README

帮用户为项目自动生成一份专业的 README 文档。

## 步骤

### 1. 分析项目

自动读取项目中的关键文件：
- package.json / pyproject.toml / go.mod → 项目名、描述、依赖
- 项目目录结构 → 了解项目组成
- CLAUDE.md → 项目描述和技术栈信息
- 已有 README → 保留有价值的内容

### 2. 提问补充

> 有几个信息需要确认：
> 1. 一句话描述这个项目（如果还没有的话）
> 2. 项目目前是什么状态？（开发中 / 可用 / 稳定）
> 3. README 用中文还是英文？

### 3. 生成 README

生成包含以下部分的 README.md：

- **项目标题和描述** — 简洁有力的一句话
- **功能特性** — 项目核心功能的要点列表
- **快速开始** — 安装和运行的最少步骤
- **使用方法** — 基本用法和示例
- **技术栈** — 使用的主要技术
- **项目结构** — 关键目录和文件说明（简洁版）
- **开发指南** — 如何参与开发（如果需要）
- **License** — 许可证信息

规则：
- 内容从项目实际代码中提取，不要编造功能
- 安装步骤要准确可执行
- 保持简洁，不要把 README 写成文档站

### 4. 确认

展示生成的内容，用户确认后写入。