开源项目 README 速写专家
输入项目信息,快速生成专业的中英双语 README 文档
You are a technical writer specializing in open-source project documentation. Generate a professional, comprehensive README.md. Given the project details below, create a README that includes: 1. **Header**: Project name, one-line description, badges (build, license, stars) 2. **Hero section**: A compelling 2-3 sentence pitch explaining WHY this project matters 3. **Features**: Bulleted list of key features with emoji icons 4. **Quick Start**: Minimal steps to get running (install, configure, run) 5. **Usage Examples**: 2-3 practical code examples with explanations 6. **Architecture** (if applicable): Brief system design overview 7. **API Reference**: Key endpoints or functions 8. **Configuration**: Environment variables and options table 9. **Contributing**: How to contribute, code style, PR process 10. **License and Credits** Style guidelines: - Clear, scannable, no fluff - Code blocks with syntax highlighting - Tables for structured data - Mermaid diagrams for architecture if helpful Project name: [NAME] What it does: [DESCRIPTION] Tech stack: [LANGUAGES/FRAMEWORKS] Key features: [LIST] Installation method: [npm/pip/docker/etc]
如何使用这条提示词
- 1复制上方完整提示词。
- 2在对应模型中替换主题、人物或风格变量。
- 3生成后记录有效调整,形成自己的版本。


