一个项目的 README.md 应该如何编写

查看 104|回复 7
作者:lingeo   
有没有如何编写 README.md 的规范?每次写文档都难受的要死,删了改改了删,最后写出来自己都读不下去😟。

编写, 难受, 文档

yolee599   
不想自己写 github 上找一个自己喜欢的模仿不就行了
lsk569937453   
很简单啊,先找你的开源竞品看看他们是怎么写的。
weeei   
这个困扰付费可破。
icyalala   
https://github.com/othneildrew/Best-README-Template
https://github.com/matiassingers/awesome-readme
多看看,选一些自己喜欢的模仿一下,没内容就就让 GPT 帮一下
mringg   
个人感觉,也不用太复杂,但是关键的信息得有。
默认编译环境:操作系统版本,编译器的版本
运行依赖:操作系统,runtime ,其他中间件版本等
产品相关:产品原型地址,设计图地址
如果有啥重要的提醒,再补充下就好了
darksword21   
就写 WIP
lingeo
OP
  
@icyalala 这个好,感谢。
您需要登录后才可以回帖 登录 | 立即注册

返回顶部