# Readme Gen

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

- **Type:** Skill
- **Install:** `agentstack add skill-lightpointventures-claude-code-starter-readme-gen`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [lightpointventures](https://agentstack.voostack.com/s/lightpointventures)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [lightpointventures](https://github.com/lightpointventures)
- **Source:** https://github.com/lightpointventures/claude-code-starter/tree/main/skills/readme-gen
- **Website:** https://github.com/lighthouse-strategy/claude-code-starter

## Install

```sh
agentstack add skill-lightpointventures-claude-code-starter-readme-gen
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# 生成 README

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

## 步骤

### 1. 分析项目

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

### 2. 提问补充

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

### 3. 生成 README

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

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

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

### 4. 确认

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

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [lightpointventures](https://github.com/lightpointventures)
- **Source:** [lightpointventures/claude-code-starter](https://github.com/lightpointventures/claude-code-starter)
- **License:** MIT
- **Homepage:** https://github.com/lighthouse-strategy/claude-code-starter

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-lightpointventures-claude-code-starter-readme-gen
- Seller: https://agentstack.voostack.com/s/lightpointventures
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.