在GitHub官網(wǎng)上如何記錄項(xiàng)目

良好的文檔是任何項(xiàng)目成功的關(guān)鍵。使文檔可訪問使人們能夠了解項(xiàng)目; 使更新變得容易，確保文檔保持相關(guān)性。
記錄項(xiàng)目的兩種常用方法是README文件和wiki：
README文件是其他用戶更快速，更簡單地了解您的工作的方法。
GitHub上的Wiki可幫助您以有用的方式提供有關(guān)項(xiàng)目的深入信息。
至少在你的項(xiàng)目中有一個README是個好主意，因?yàn)檫@是許多人第一次找到你的作品時會讀到的東西。
創(chuàng)建自述文件
當(dāng)你創(chuàng)建一個新的存儲庫，雖然GitHub上，選擇“初始化這個資源庫和自述”，除非你打算導(dǎo)入現(xiàn)有的資源庫。 您的README.md文件現(xiàn)在可以在全新的存儲庫中進(jìn)行編輯。您的項(xiàng)目名稱位于頂部，后面是您在創(chuàng)建存儲庫時選擇包含的任何描述。自述文件很容易在GitHub或本地修改。查看Mastering Markdown指南，了解有關(guān)如何在創(chuàng)建文件后修改文本的詳細(xì)信息。
格式化README
自述文件通常遵循一種格式，以便立即將開發(fā)人員定位到項(xiàng)目的最重要方面。
項(xiàng)目名稱：您的項(xiàng)目名稱是人們在向下滾動到自述文件時會看到的第一個名稱，并且在創(chuàng)建自述文件時包含在內(nèi)。
描述：您的項(xiàng)目描述如下。一個好的描述是清楚，簡短，重點(diǎn)。描述項(xiàng)目的重要性及其作用。
目錄：可選地，包括一個目錄，以便其他人快速瀏覽特別長或詳細(xì)的自述文件。
安裝：安裝是有效自述文件的下一部分。告訴其他用戶如何在本地安裝項(xiàng)目。（可選）包含一個gif，以使其他人更清楚。
用法：下一部分是用法，在其中指導(dǎo)其他人在安裝項(xiàng)目后如何使用項(xiàng)目。這也是一個包含項(xiàng)目截圖的好地方。
貢獻(xiàn)：較大的項(xiàng)目通常有關(guān)于為其項(xiàng)目做出貢獻(xiàn)的部分，其中概述了貢獻(xiàn)說明。有時，這是一個單獨(dú)的文件。如果您有特定的貢獻(xiàn)偏好，請解釋它們，以便其他開發(fā)人員知道如何最好地為您的工作做出貢獻(xiàn)。要了解有關(guān)如何幫助其他人貢獻(xiàn)的更多信息，請查看為存儲庫貢獻(xiàn)者設(shè)置指南的指南。
學(xué)分：包括學(xué)分部分，以突出顯示并鏈接到您項(xiàng)目的作者。
許可證：最后，包括項(xiàng)目許可證的部分。有關(guān)選擇許可證的更多信息，請查看GitHub的許可指南！
您的自述文件應(yīng)僅包含開發(fā)人員開始使用和為您的項(xiàng)目做出貢獻(xiàn)的必要信息。更長的文檔最適合wiki，如下所述。
創(chuàng)建你的wiki
GitHub上的每個存儲庫都附帶一個wiki。創(chuàng)建存儲庫后，您可以通過側(cè)欄導(dǎo)航設(shè)置包含的Wiki。啟動維基只需單擊維基按鈕并創(chuàng)建第一頁即可。