大海

SIMPLE THE COMPLEX

github上了上传了许多仓库,如何更好的管理、使用这些仓库,其中关键的一点在于README的编写。README的目的是向使用者展示仓库的使用方法、来历以及未来的进展。越来越重视写好一个REAMDE优秀的工程不一定有一个好的README,但是不好的REAMDE一定不是一个优秀的工程

关于这个问题在网上也有许多讨论:如何写好Github中的readme?。当前主要参考了一个关于如何编写标准READMEgithub仓库:RichardLitt/standard-readme

阅读全文 »