Skip to content

Commit 53bf033

Browse files
Update README文档的规范写法.md
1 parent 282f4eb commit 53bf033

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

github_README/README文档的规范写法.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
本文原文请查看我的博客[开发工具总结(9)之 Github 开源项目的README文档的最全最规范写法](https://www.jianshu.com/p/813b70d5b0de)
2+
13
看过很多开源库,发现有些库的文档写的一团糟,有的甚至就是一个标题,让你自己下载之后运行,自己摸索,看的很头疼。而那些使用量大的库的文档写的很标准,很详细,看的很舒服。
24

35
README文档写的好的话能减少很多使用成本,能帮助这个库让更多人了解,更多的人用,可以说好的文档就是一个门面。

0 commit comments

Comments
 (0)