JavaShuo
欄目
標籤
Github README.md編寫指南
時間 2021-01-04
標籤
Github
欄目
Git
简体版
原文
原文鏈接
以MMdnn項目爲例,總結開源項目README.md的一般編寫套路。從內容和展示形式兩方面進行說明。 內容 README.md最好要包含: 項目名稱及簡介 項目特點 項目安裝指南 項目功能及使用指南 使用範例 其他說明 展示形式 基本內容 下面是README.md子版塊內容示例,它基本呈現了編寫某板塊內容的幾個要素及其展示形式: 標題:項目名稱採用一級標題,因此其子塊內容多采用二級、三級甚至更低級
>>阅读原文<<
相關文章
1.
Markdown編寫github README.md
2.
GitHub中的README.md編寫
3.
如何寫github的README.md
4.
GitHub編輯README.md文件
5.
Poc編寫指南
6.
Dockerfile編寫指南
7.
Github README.md語法
8.
github中README.md文件寫法解析
9.
寫markdown用於Github上readme.md文件
10.
RESTful API 編寫指南
更多相關文章...
•
SQL 指南
-
網站建設指南
•
HTML 指南
-
網站建設指南
•
Github 簡明教程
•
算法總結-雙指針
相關標籤/搜索
readme.md
編程指南
指南
編寫
OpenCL編程指南
WebGL編程指南
Python編程指南
github
寫寫
Git
網站建設指南
PHP教程
Hibernate教程
Github
0
分享到微博
分享到微信
分享到QQ
每日一句
每一个你不满意的现在,都有一个你没有努力的曾经。
最新文章
1.
深度學習硬件架構簡述
2.
重溫矩陣(V) 主成份分析
3.
國慶佳節第四天,談談我月收入增加 4K 的故事
4.
一起學nRF51xx 23 - s130藍牙API介紹
5.
2018最爲緊缺的十大崗位,技術崗佔80%
6.
第一次hibernate
7.
SSM項目後期添加數據權限設計
8.
人機交互期末複習
9.
現在無法開始異步操作。異步操作只能在異步處理程序或模塊中開始,或在頁生存期中的特定事件過程中開始...
10.
微信小程序開發常用元素總結1-1
本站公眾號
歡迎關注本站公眾號,獲取更多信息
相關文章
1.
Markdown編寫github README.md
2.
GitHub中的README.md編寫
3.
如何寫github的README.md
4.
GitHub編輯README.md文件
5.
Poc編寫指南
6.
Dockerfile編寫指南
7.
Github README.md語法
8.
github中README.md文件寫法解析
9.
寫markdown用於Github上readme.md文件
10.
RESTful API 編寫指南
>>更多相關文章<<