如何编写好的README
在github
上了上传了许多仓库,如何更好的管理、使用这些仓库,其中关键的一点在于README
的编写。README
的目的是向使用者展示仓库的使用方法、来历以及未来的进展。越来越重视写好一个REAMDE
,优秀的工程不一定有一个好的README
,但是不好的REAMDE
一定不是一个优秀的工程
关于这个问题在网上也有许多讨论:如何写好Github中的readme?。当前主要参考了一个关于如何编写标准README
的github
仓库:RichardLitt/standard-readme