JavaShuo
欄目
標籤
如何寫一個通用的README規範
時間 2021-06-05
標籤
Git
github
欄目
Git
简体版
原文
原文鏈接
我們在Github上創建項目的時候,常常會看到默認使用README文件初始化該項目,然後在新建項目的根目錄下就會生成README.md文件。 有好的README文檔的項目不一定是一個好的開源項目,但一個好開源項目一定有一個好的README 1. README文檔的組成部分 (一)國際化 (二)項目工程介紹 (三)項目的使用效果圖 (四)項目特點 (五)項目的基本結構(架構) (六)集成方式 (七)
>>阅读原文<<
相關文章
1.
如何寫一個通用的README規範
2.
如何爲開發項目編寫規範的README文件
3.
README文檔的規範寫法
4.
如何爲開發項目編寫規範的README文件(windows),此文詳解
5.
[譯] 如何編寫友好的 README
6.
【matlab】如何規範地編寫一個函數文件
7.
如何編寫一個規範的測試用例?你應該知道的!
8.
如何寫PHP規範註釋
9.
一個超長SQL語句的規範書寫格式範例.
10.
一個超長SQL語句的規範書寫格式範例
更多相關文章...
•
XSD 如何使用?
-
XML Schema 教程
•
如何僞造ARP響應?
-
TCP/IP教程
•
Java Agent入門實戰(一)-Instrumentation介紹與使用
•
C# 中 foreach 遍歷的用法
相關標籤/搜索
readme
規範
如何
何如
何用
如用
寫的
如一
通用
設計規範
Git
SQLite教程
Spring教程
Docker教程
應用
0
分享到微博
分享到微信
分享到QQ
每日一句
每一个你不满意的现在,都有一个你没有努力的曾经。
最新文章
1.
android 以太網和wifi共存
2.
沒那麼神祕,三分鐘學會人工智能
3.
k8s 如何 Failover?- 每天5分鐘玩轉 Docker 容器技術(127)
4.
安裝mysql時一直卡在starting the server這一位置,解決方案
5.
秋招總結指南之「性能調優」:MySQL+Tomcat+JVM,還怕面試官的轟炸?
6.
布隆過濾器瞭解
7.
深入lambda表達式,從入門到放棄
8.
中間件-Nginx從入門到放棄。
9.
BAT必備500道面試題:設計模式+開源框架+併發編程+微服務等免費領取!
10.
求職面試寶典:從面試官的角度,給你分享一些面試經驗
本站公眾號
歡迎關注本站公眾號,獲取更多信息
相關文章
1.
如何寫一個通用的README規範
2.
如何爲開發項目編寫規範的README文件
3.
README文檔的規範寫法
4.
如何爲開發項目編寫規範的README文件(windows),此文詳解
5.
[譯] 如何編寫友好的 README
6.
【matlab】如何規範地編寫一個函數文件
7.
如何編寫一個規範的測試用例?你應該知道的!
8.
如何寫PHP規範註釋
9.
一個超長SQL語句的規範書寫格式範例.
10.
一個超長SQL語句的規範書寫格式範例
>>更多相關文章<<