了解一個項目，恐怕首先都是通過其readme檔案了解資訊。如果你以為readme檔案都是随便寫寫的那你就錯了。github，oschina git gitcafe的代碼托管平台上的項目的readme.md檔案都是有其特有的文法的。稱之為markdown文法。基本規則如下：
如果直接記文法，那似乎困難了些。這裡onecoder推薦兩個markdown的編輯器。
線上編輯器：stackedit
mac下離線編輯器mou
onecoder這裡使用的是後者為自己的shurnim-storage項目寫readme。至于這個項目是什麼，見readme文檔，onecoder也會在另外的博文做一些補充說明。成品readme如下：
效果預覽：
原文：http://www.coderli.com/write-readme-for-your-project/