README.md的作用

README.md檔案是一個專案的入門手冊，裡面介紹了整個專案達到什麼樣子的效果、需要搭建什麼樣的環境、具備什麼樣的技能等等。所以README檔案寫得好不好，關係到這個專案能不能更容易的被其他人使用。下面詳細的介紹一下README.md檔案要怎麼寫可以更好更直觀。

命名規範

在github，gitlab等程式碼託管伺服器上建立一個倉庫時，伺服器一般會建議在程式碼工程中新增一個README.md檔案，大家應該會有這樣的疑問，為什麼這個檔名不是readme.md， readme.txt等等。以下是個人幾點看法:
(1) README採用全大寫，主要是可以跟程式碼檔案直觀的區分開，readme.md乍一看有點像是程式碼檔案，不夠直觀。這不夠體現出它優先其他工程檔案被閱讀的初衷。
方式一

main.c
main.h
helloworld.c
helloworld.h
README.md

方式二

main.c
main.h
helloworld.c
helloworld.h
readme.md

以上兩種檔案目錄可以看到，如果程式碼檔案很多的時候，readme檔案是比較難找到的，所以建議名稱採用全大寫。
(2) ‘R’的ASCII碼為0x52,’r’的ASCII碼為0x72，這有利於在排序時README.md會比較靠前。
(3) README檔案的字尾名採用是.md。該種字尾的檔案主要是採用markdown規則編寫的。採用markdown規則可以很方便的在文字中新增格式，編寫的關注點轉移到文件內容本身，而不需要像富文字那樣要一直修改內容格式，或者像txt文字文件那樣沒有格式，會造成閱讀混亂。

內容結構

1. [功能描述]：主要描述一下這個專案的主要功能列表。
2. [開發環境]：羅列使用本工程專案所需要安裝的開發環境及配置，以及所需軟體的版本說明和對應的下載連結。
3. [專案結構簡介]：簡單介紹專案模組結構目錄樹，對使用者可以修改的檔案做重點說明。
4. [測試DEMO]：此處可以簡單介紹一下DEMO程式的思路，具體實現程式碼放在example資料夾中。
5. [作者列表]：對於多人合作的專案，可以在這裡簡單介紹並感謝所有參與開發的研發人員。
6. [更新連結]：提供後續更新的程式碼連結。
7. [歷史版本]：對歷史版本更改 記錄做個簡單的羅列，讓使用者直觀的瞭解到哪些版本解決了哪些問題。
8. [聯絡方式]：可以提供微信、郵箱等聯絡方式，其他人對這個工程不明白的地方可以通過該聯絡方式與你聯絡。