这是一个创建于 585 天前的主题，其中的信息可能已经有所发展或是发生改变。
有没有如何编写 README.md 的规范？每次写文档都难受的要死，删了改改了删，最后写出来自己都读不下去😟。
 |
1
yolee599 2023-04-23 09:41:41 +08:00
不想自己写 github 上找一个自己喜欢的模仿不就行了
|
 |
2
lsk569937453 2023-04-23 09:42:45 +08:00
很简单啊，先找你的开源竞品看看他们是怎么写的。
|
 |
3
weeei 2023-04-23 09:43:23 +08:00
这个困扰付费可破。
|
 |
4
icyalala 2023-04-23 09:45:43 +08:00  3
https://github.com/othneildrew/Best-README-Template
https://github.com/matiassingers/awesome-readme 多看看，选一些自己喜欢的模仿一下，没内容就就让 GPT 帮一下 |
 |
5
mringg 2023-04-23 09:48:26 +08:00 via iPhone
个人感觉，也不用太复杂，但是关键的信息得有。
默认编译环境：操作系统版本，编译器的版本 运行依赖：操作系统，runtime ，其他中间件版本等 产品相关：产品原型地址，设计图地址 如果有啥重要的提醒，再补充下就好了 |
 |
6
darksword21 2023-04-23 09:49:45 +08:00 2
就写 WIP
|
 |
8
tyzandhr 2023-04-23 11:29:42 +08:00 via Android 1
就像教材一样写啊，如何 get started ，如何使用 api 或者如何配置，背后的原理，如何贡献代码
|
 |
9
ufo5260987423 2023-04-23 11:43:55 +08:00 1
根据项目内容和状态，不同阶段要有不同的写法。最关键的是你要知道自己项目的用户在想啥。
拿我自己的项目举例： https://github.com/ufo5260987423/scheme-langserver 1 、要介绍这个项目是干啥的，两三句解决掉； 2 、介绍这个项目的背景和发行方式，一段话两三句。 3 、使用效果，最好带上图，这块可以多弄一点，要一下子抓住人家的眼球； 4 、如果是开发过程中的项目，交代一下开发状态；如果已经发布了若干个版本，要简单介绍一下各个版本干了啥； 5 、如何使用、部署、编译项目，要让人家顺着你这个介绍一步步就能把项目用起来； 6 、描述一下愿景：我将来要发什么功能； 7 、如何测试、debug 以及其他。 其实如果你写过论文的话，这些都是很正常的东西。 |
 |
10
lete 2023-04-23 12:02:24 +08:00
|
 |
11
artnowben 2023-04-23 12:12:55 +08:00
1. 支持中英文，虽然是中文用户居多，但是英文也要支持
2. 说明项目的用途，有什么优势，有测试数据支撑 3. quick start 部分：如何编译，运行一个简单的例子 4. Documentation：列出使用文档，设计文档的链接等 5. Related Articles(相关文章)：新闻、博客文章 6. License 7. 作者 （可选） 8. 如何贡献 （可选） 开源网络性能测试仪 dperf 的 readme 供参考： https://github.com/pengjianzhang/dperf |
 |
12
nashaofu 2023-04-23 13:12:22 +08:00 via iPhone
github 上有人使用 chatgpt 生成 readme 的，地址不记得了。使用下来挺好的，而且可以帮你做 readme 翻译，例如中文 readme 生成英文的，翻译水平比我高太多了
|
 |
13
litchinn 2023-04-23 14:39:51 +08:00
介绍下干嘛的
介绍下特点 介绍下怎么用 如果项目大，将项目的详细文档链接贴出来 |
 |
14
krapnik 2023-04-23 15:14:52 +08:00
|
 |
15
DIO 2023-04-23 15:17:58 +08:00
我觉得最基本就是介绍（突出亮点）和使用方法吧。其他的按需添加
|
 |
16
majula 2023-04-24 08:15:49 +08:00
readme 不是文档
用客观简洁的话描述一下你的项目是干什么用的即可。如果真的有人想用你的项目，会自行到项目根目录下找 "doc" "man" 之类的目录来看文档，看 tag 找 release 当然如果文档没有和源码放一个仓库，视情况也可以带上文档或者项目官网的链接。同理也可以带上 prebuilt binaries 的下载地址 |
Select Language