自述檔案

如果你的專案沒有 README.md，GitHub 可能會解析 README.rdoc 以顯示詳細資訊。如果它有兩者，它將使用 README.md，默默地忽略 rdoc。

自述檔案可包括─

專案名稱

簡要描述一下你的專案。你還可以提供專案的網站連結，徽章，社群和聯絡資訊（即電子郵件，社交網站）。

下載

可執行檔案（可執行檔案或縮小檔案或安裝檔案）連結。也可以連結到以前的版本。

安裝

如何使用你的工作。它可能包括先決條件，設定，第三方庫，用法，注意事項等。

示範

它可能包括程式碼示例，gif 檔案，視訊連結，甚至螢幕截圖。

作者

作者姓名，聯絡資訊等

致謝

在整個專案中幫助和激發了人員或社群的名單

特約

向專案提供貢獻（即新增功能，報告錯誤，提交補丁）的說明。也可能包含文件連結。

執照

簡要介紹一下你的許可證。你也可以提供許可證站點的連結。