什么是Readme耻姥？
README（顧名思義：“read me“）是啟動新項目時應該閱讀的第一個文件。它既包含了一系列關于項目的有用信息又是一個項目的手冊有咨。它是別人在 Github 或任何 Git 托管網(wǎng)站點琐簇，打開你倉庫時看到的第一個文件。
Readme.md 文件位于倉庫的根目錄中座享，在 Github 上的項目目錄下它會自動顯示婉商。
.md 這個文件后綴名來自于單詞：markdown似忧。它是一種用于文本格式化的標記語言。就像 HTML 一樣据某，可以結(jié)構(gòu)化地展示我們的文檔橡娄。
為什么要寫Readme？
README文件的意義在于說明你的項目做了什么? 運行在什么樣環(huán)境下? 如何查看/編輯代碼? 其目的在于向使用者描述該項目的信息癣籽，讓讀者快速了解這個項目挽唉。
就像找工作要寫個人簡歷一樣，為自己的開源項目寫一個優(yōu)秀的 README 文檔同樣重要筷狼。好的 README 文檔可以幫助你在眾多將項目寄托到github上的開發(fā)人員中脫穎而出瓶籽。
在Readme里寫些什么？
項目標題
這是整個項目的名稱埂材，標題應具有自我解釋性塑顺，盡量不要太拗口。
項目簡述
添加一些簡短的陳述俏险，描述整個項目出現(xiàn)原因和作用严拒。包括但不限于
你的項目的作用
你使用某種技術的原因
你面臨的一些挑戰(zhàn)和還未實現(xiàn)的功能
添加新功能或修復錯誤
這是為了讓別人了解如何在你的項目中提出問題或提出功能要求。
目錄（可選）
如果你的readme文件很長竖独，可能需要添加一個目錄裤唠，以方便用戶查找所需內(nèi)容，幫助他們快速導向文件的不同部分莹痢。
安裝
如果你的項目是需要安裝的軟件或應用程序种蘸，則應包括安裝項目所需的步驟。提供如何運行開發(fā)環(huán)境的手把手教學說明竞膳。
使用
提供說明和示例航瞭，以便用戶/貢獻者可以使用該項目。這將使他們在遇到問題時更容易解決坦辟，你還可以引用屏幕截圖來顯示正在運行的項目示例刊侯。
最好對項目進行演示或預覽（視頻 / gif / 屏幕截圖都是不錯的選擇），以便人們知道你的項目中會有什么锉走。（圖片滨彻、視頻鏈接、在線演示 Demo 鏈接)
友情鏈接
如果你作為團隊或組織參與項目挠日，請列出你的合作者/團隊成員塘娶。你還應該引用指向他們的GitHub簡介的鏈接积锅。
此外，如果你引用了其他的輔助項目來構(gòu)建特定的項目，也請在這里引用指向該項目的鏈接畦幢。
列出許可
這是大多數(shù)readme文件的最后一部分。它讓其他開發(fā)人員知道他們可以或者不能對你的項目做什么操作。如果你需要選擇許可，使用<u>https://choosealicense.com/</u> 庇麦。
?? 上面列出的部分是良好readme的最低要求。但你可能還需要考慮添加以下部分喜德。
徽章（可選）
徽章會使用戶有一定的真實感山橄。你可以從下面的網(wǎng)址，為你的倉庫設置自定義或者常規(guī)使用的盾牌（徽章）：https://shields.io
你還可以設置個性化的盾牌舍悯，如倉庫的的星星數(shù)量和代碼百分比指標航棱。
貢獻
如果你創(chuàng)建了一個應用程序或包，并且希望其他開發(fā)人員對其做出貢獻（一個開源項目）萌衬，那么你需要添加一些指導原則饮醇，讓他們知道如何為你的項目做出貢獻。
測試
為你的應用程序編寫測試秕豫。然后提供代碼示例以及如何運行它們朴艰。
