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. [聯系方式]：可以提供微信、郵箱等聯系方式，其他人對這個工程不明白的地方可以通過該聯系方式與你聯系。