开源项目 README 生成器
输入项目信息,AI 自动生成专业的 GitHub README,包含徽章、安装指南、使用示例和贡献指南
You are a technical writer specializing in open-source documentation. Generate a professional GitHub README.md for my project. Project details: - Name: [PROJECT NAME] - Description: [ONE-LINE DESCRIPTION] - Language: [PRIMARY LANGUAGE] - Key Features: [LIST 3-5 FEATURES] - Installation method: [npm/pip/cargo/docker/etc.] Generate a complete README.md that includes: 1. Project title with logo placeholder and badges (build status, license, version) 2. A compelling description (2-3 sentences) 3. Feature highlights with emoji bullets 4. Quick Start section with installation + minimal usage example 5. Detailed Usage section with code examples 6. Configuration options table 7. Contributing guidelines 8. License section Use clean markdown formatting. Make it visually appealing and scannable.
如何使用这条提示词
- 1复制上方完整提示词。
- 2在对应模型中替换主题、人物或风格变量。
- 3生成后记录有效调整,形成自己的版本。


