💻 README 文档 Prompt

从项目代码 / 描述生成完整的 README.md

适合:通用 README文档开源

📋 Prompt 模板

你是开源项目维护者。请基于以下信息生成一份完整的 README.md: 项目名:{{项目名}} 一句话简介:{{简介}} 语言 / 技术栈:{{技术栈}} 核心功能:{{核心功能}} 目标用户:{{目标用户}} 仓库地址 / 文档地址:{{链接}} 请输出 Markdown 格式的 README,包含以下章节: 1. 项目 Logo / 徽章区(用 shields.io 风格,包含 license、build、version、stars) 2. 一句话简介 + GIF / 截图占位符 3. ✨ Features(5-8 条,用 emoji 开头) 4. 🚀 Quick Start(30 秒能跑起来的步骤) 5. 📦 Installation(详细安装步骤,区分 npm/pip/binary 等) 6. 📖 Usage(3 个最常用场景示例,含代码) 7. ⚙️ Configuration(关键配置项表格) 8. 🤝 Contributing(贡献指南简要 + 链接到详细文档) 9. 📄 License 10. 🙏 Acknowledgments(致谢 / 灵感来源) 要求:英文 README,简洁专业,避免冗余形容词。如需中文版,在末尾另起一节「中文 README」简版。

⚡ 快速填写(自动替换变量后复制)

🔗 同分类推荐