轉載自：http://www.coderli.com/write-readme-for-your-project/ ，侵刪。

瞭解一個專案，恐怕首先都是通過其Readme檔案瞭解資訊。如果你以為Readme檔案都是隨便寫寫的那你就錯了。github，oschina git gitcafe的程式碼託管平臺上的專案的Readme.MD檔案都是有其特有的語法的。稱之為Markdown語法。基本規則如下：

Markdown 語法速查表
1 標題與文字格式
標題
# 這是 H1 <一級標題>
## 這是 H2 <二級標題>
###### 這是 H6 <六級標題>
文字格式
**這是文字粗體格式**
*這是文字斜體格式*
~~在文字上新增刪除線~~
2 列表
無序列表
* 專案1
* 專案2
* 專案3
有序列表
1. 專案1
2. 專案2
3. 專案3
   * 專案1
   * 專案2
3 其它
圖片
連結
[連結名稱](http://gitcafe.com)
引用
> 第一行引用文字
> 第二行引用文字
水平線
***
程式碼
`<hello world>`
程式碼塊高亮
```ruby
  def add(a, b)
    return a + b
  end
```
表格
  表頭  | 表頭
  ------------- | -------------
 單元格內容  | 單元格內容
 單元格內容l  | 單元格內容

如果直接記語法，那似乎困難了些。這裡OneCoder推薦兩個Markdown的編輯器。