Skip to content

Commit

Permalink
Update README文档的规范写法.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AweiLoveAndroid authored Dec 29, 2018
1 parent 282f4eb commit 53bf033
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions github_README/README文档的规范写法.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
本文原文请查看我的博客[开发工具总结(9)之 Github 开源项目的README文档的最全最规范写法](https://www.jianshu.com/p/813b70d5b0de)

看过很多开源库,发现有些库的文档写的一团糟,有的甚至就是一个标题,让你自己下载之后运行,自己摸索,看的很头疼。而那些使用量大的库的文档写的很标准,很详细,看的很舒服。

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

0 comments on commit 53bf033

Please sign in to comment.