readme-generator

name	readme-generator
description	自动生成专业的项目 README 文档，包含项目介绍、安装指南、使用说明等内容

README 生成器

描述

自动为项目生成美观、专业的 README 文档，包含完整的项目介绍、安装说明、使用指南、贡献指南等内容。

使用场景

• 新建项目时，快速生成基础 README
• 已有项目需要完善或更新文档
• 发布开源项目前，准备规范的项目说明

指令

生成 README 时，你应该：

1. 分析项目信息

   • 检测项目类型（通过 package.json、requirements.txt 等文件）
   • 了解项目的主要功能和特点
   • 识别技术栈和依赖

2. 生成标准结构

   • 项目标题和简介
   • 功能特性列表
   • 安装和配置说明
   • 使用示例和指南
   • 贡献指南（可选）
   • 许可证信息（可选）

3. 优化内容

   • 使用清晰、易懂的语言
   • 提供具体的使用示例
   • 根据项目特点调整内容侧重点

示例

输出的 README 结构

# 项目名称

> 项目简短描述

## ✨ 功能特性
- 功能 1
- 功能 2
- 功能 3

## 🚀 快速开始

### 安装
```bash
# 安装依赖
npm install

使用

// 使用示例

📖 文档

🤝 贡献指南

📄 许可证