README文檔的規範寫法

看過很多開源庫，發現有些庫的文檔寫的一團糟，有的甚至就是一個標題，讓你自己下載之後運行，自己摸索，看的很頭疼。而那些使用量大的庫的文檔寫的很標準，很詳細，看的很舒服。 README文檔寫的好的話能減少很多使用成本，能幫助這個庫讓更多人瞭解，更多的人用，可以說好的文檔就是一個門面。 有好的 README 文檔的項目不一定是一個好開源項目，但一個好開源項目一定有一個好的 README。 下面就簡單的總

>>阅读原文<<