2
一个项目的 README.md 应该如何编写
source link: https://www.v2ex.com/t/934678
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
有没有如何编写 README.md 的规范？每次写文档都难受的要死，删了改改了删，最后写出来自己都读不下去😟。
12 条回复 • 2023-04-23 13:12:22 +08:00
 |
yolee599 3 小时 59 分钟前 不想自己写 github 上找一个自己喜欢的模仿不就行了
|
 |
lsk569937453 3 小时 58 分钟前 很简单啊，先找你的开源竞品看看他们是怎么写的。
|
 |
weeei 3 小时 58 分钟前 这个困扰付费可破。
|
 |
mringg 3 小时 53 分钟前 via iPhone 个人感觉，也不用太复杂，但是关键的信息得有。
默认编译环境：操作系统版本，编译器的版本 运行依赖：操作系统，runtime ，其他中间件版本等 产品相关：产品原型地址，设计图地址 如果有啥重要的提醒，再补充下就好了 |
 |
darksword21 3 小时 51 分钟前 就写 WIP
|
2
 |
tyzandhr 2 小时 11 分钟前 via Android 就像教材一样写啊，如何 get started ，如何使用 api 或者如何配置，背后的原理，如何贡献代码
|
 |
ufo5260987423 1 小时 57 分钟前 根据项目内容和状态，不同阶段要有不同的写法。最关键的是你要知道自己项目的用户在想啥。
拿我自己的项目举例： https://github.com/ufo5260987423/scheme-langserver 1 、要介绍这个项目是干啥的，两三句解决掉； 2 、介绍这个项目的背景和发行方式，一段话两三句。 3 、使用效果，最好带上图，这块可以多弄一点，要一下子抓住人家的眼球； 4 、如果是开发过程中的项目，交代一下开发状态；如果已经发布了若干个版本，要简单介绍一下各个版本干了啥； 5 、如何使用、部署、编译项目，要让人家顺着你这个介绍一步步就能把项目用起来； 6 、描述一下愿景：我将来要发什么功能； 7 、如何测试、debug 以及其他。 其实如果你写过论文的话，这些都是很正常的东西。 |
 |
lete 1 小时 39 分钟前 |
 |
artnowben 1 小时 28 分钟前 1. 支持中英文，虽然是中文用户居多，但是英文也要支持
2. 说明项目的用途，有什么优势，有测试数据支撑 3. quick start 部分：如何编译，运行一个简单的例子 4. Documentation：列出使用文档，设计文档的链接等 5. Related Articles(相关文章)：新闻、博客文章 6. License 7. 作者 （可选） 8. 如何贡献 （可选） 开源网络性能测试仪 dperf 的 readme 供参考： https://github.com/pengjianzhang/dperf |
 |
nashaofu 29 分钟前 via iPhone github 上有人使用 chatgpt 生成 readme 的，地址不记得了。使用下来挺好的，而且可以帮你做 readme 翻译，例如中文 readme 生成英文的，翻译水平比我高太多了
|
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK