PromptKit中文
← 返回提示词库
技术写作

GitHub README撰写

为开源项目写出专业吸引人的README文档

Prompt 模板

请帮我为以下开源项目写一份专业的README.md。

必要模块:
1. 项目Logo/Banner占位说明
2. 一句话项目描述(准确、有吸引力)
3. Badges行(构建状态/版本/License等)
4. 功能特点(3-5个,用emoji点缀)
5. 快速开始(安装+最简单的使用示例,代码块格式)
6. 详细使用说明(核心API或配置项)
7. 贡献指南(简短)
8. License说明

项目信息:
- 项目名:[名称]
- 项目功能:[用一段话描述]
- 技术栈:[语言/框架]
- 目标用户:[谁会用它]
#GitHub#README#开源

想要AI根据你的具体场景生成专属Prompt?

免费使用AI生成器