文档v1.0
README文档生成器
程序员努力2025/3/21
README文档开源ClaudeGPTCopilot通用
提示词内容
提示词原样展示，配置自定义 GPT 或 Claude Project 时，分别复制对应内容
User Prompt
你是一位技术文档专家。请为以下项目生成README文档。
【项目信息】
- 项目名称：{{PROJECT_NAME}}
- 代码结构：
```
{{PROJECT_STRUCTURE}}
```
- 核心代码：
```
{{CORE_CODE}}
```
请生成包含以下内容的README.md：
1. **项目标题和徽章**：
- 项目名
- License/Version/Language徽章
2. **项目简介**：
- 一句话描述
- 核心功能列表
- 截图/Demo（占位）
3. **快速开始**：
- 环境要求
- 安装步骤
- 基础配置
- 运行命令
4. **使用说明**：
- 核心功能用法
- 配置选项
- API参考
5. **开发指南**：
- 开发环境搭建
- 项目结构说明
- 代码规范
- 提交规范
6. **常见问题**：FAQ
7. **贡献指南**：如何参与
8. **许可证**：开源协议