readme-generator — 生产级 README 生成器

分析项目结构，并生成一份全面、框架感知的 README.md。

步骤

1. 分析项目结构

读取以下文件（若存在）：

• package.json / pyproject.toml / Cargo.toml / go.mod — 名称、描述、版本、依赖项
• tsconfig.json — TypeScript 配置
• docker-compose.yml / Dockerfile — 容器化配置
• .github/workflows/ — CI/CD 流水线
• LICENSE / LICENSE.md — 许可证类型
• 入口文件： src/index.*、src/main.*、app.*、main.*、index.*
• tests/ / test/ / __tests__/ / spec/ — 测试配置

# 获取文件树（深度为 3，忽略常见目录）
find . -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/__pycache__/*' | head -100
# Windows 替代命令：
Get-ChildItem -Recurse -Depth 3 -Exclude node_modules,.git,dist,__pycache__ | Select-Object -First 100 FullName

2. 检测框架与技术生态

3. 确定安装与运行命令

依据检测到的技术生态确定：

Node.js：检查锁文件以判断包管理器。

• pnpm-lock.yaml → pnpm install / pnpm dev
• yarn.lock → yarn / yarn dev
• package-lock.json → npm install / npm run dev
• 读取 package.json 中的 scripts 字段获取可用命令。

Python：检查 pip、poetry、pipenv 的使用情况。

• poetry.lock → poetry install / poetry run ...
• Pipfile → pipenv install / pipenv run ...
• requirements.txt → pip install -r requirements.txt

Rust： cargo build / cargo run

Go： go build / go run .

4. 生成徽章（Badges）

根据检测到的工具构建徽章 URL：

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)
![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)

仅包含实际检测到的内容对应的徽章。常见徽章包括：许可证、语言/运行时版本、CI 状态、测试覆盖率。

5. 组装 README

采用如下结构：

# Project Name

来自 package.json/pyproject.toml 的简要描述，或从代码中推断得出。

## Table of Contents
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)  ← 如适用则添加
- [Configuration](#configuration)  ← 如检测到环境变量则添加
- [Testing](#testing)
- [Deployment](#deployment)  ← 如检测到 Docker/CI 则添加
- [Contributing](#contributing)
- [License](#license)

## Features
- 关键能力要点列表（基于代码结构、路由、导出内容推断）

## Prerequisites
- 运行时版本（如 node >= 18、python >= 3.10 等）
- 所需系统工具（Docker、数据库等）

## Installation
[第 3 步中确定的、对应包管理器的安装命令]

## Usage
[开发/启动命令；若为服务端项目，补充示例 API 调用]

## API Reference
[仅适用于库/API 项目 — 列出导出的函数或端点]

## Configuration
[环境变量说明 — 若较复杂，可参考 env-setup 技能]

## Testing
[测试运行命令：npm test、pytest、cargo test 等]

## Contributing
1. Fork 仓库
2. 创建特性分支（git checkout -b feat/amazing-feature）
3. 提交更改（git commit -m 'feat: add amazing feature'）
4. 推送至分支（git push origin feat/amazing-feature）
5. 提交 Pull Request

## License
[检测到的许可证，或写“See LICENSE file”]

6. 按框架定制内容

• Next.js：补充 pages/app router、API routes、环境变量相关章节
• Express/FastAPI：记录路由结构、中间件、API 端点
• React/Vue：记录组件结构、状态管理方式、构建产物说明
• CLI 工具：记录命令行参数与标志位（flags）
• 库（Libraries）：聚焦 API 文档、安装方式及使用示例

7. 输出

将生成结果写入项目根目录下的 README.md。若该文件已存在，则先询问用户是否覆盖；并提供备选方案：写入 README.generated.md。

边界情况处理

• 单体仓库（Monorepo）：生成根目录 README，链接至各子包；同时为每个子包生成独立 README
• 空项目：生成最小骨架 README，并标注 TODO 占位符
• 无包清单文件（package manifest）：依据文件扩展名与目录结构推断项目类型
• 已有 README：覆盖前主动询问；对比差异并建议补充内容

错误处理

由 Clawb（SOVEREIGN）开发 — 更多技能敬请期待 [coming soon]