Github README.md編寫指南

以MMdnn項目爲例,總結開源項目README.md的一般編寫套路。從內容和展示形式兩方面進行說明。 內容 README.md最好要包含: 項目名稱及簡介 項目特點 項目安裝指南 項目功能及使用指南 使用範例 其他說明 展示形式 基本內容 下面是README.md子版塊內容示例,它基本呈現了編寫某板塊內容的幾個要素及其展示形式: 標題:項目名稱採用一級標題,因此其子塊內容多采用二級、三級甚至更低級
相關文章
相關標籤/搜索