日本综合一区二区|亚洲中文天堂综合|日韩欧美自拍一区|男女精品天堂一区|欧美自拍第6页亚洲成人精品一区|亚洲黄色天堂一区二区成人|超碰91偷拍第一页|日韩av夜夜嗨中文字幕|久久蜜综合视频官网|精美人妻一区二区三区

很多開發(fā)者在Github上創(chuàng)建一個項目的時候，往往忽視了Readme的重要性，實際上，Readme文件通常是你開源項目的第一個入口點，它的作用主要有告訴人們?yōu)槭裁磻?yīng)該使用你的項目，以及如何安裝和使用，一份標(biāo)準化的Readme可以簡化它的創(chuàng)建和維護，所以Readme值得你花時間去創(chuàng)建。

為寧城等地區(qū)用戶提供了全套網(wǎng)頁設(shè)計制作服務(wù)，及寧城網(wǎng)站建設(shè)行業(yè)解決方案。主營業(yè)務(wù)為網(wǎng)站制作、網(wǎng)站設(shè)計、寧城網(wǎng)站設(shè)計，以傳統(tǒng)方式定制建設(shè)網(wǎng)站，并提供域名空間備案等一條龍服務(wù)，秉承以專業(yè)、用心的態(tài)度為用戶提供真誠的服務(wù)。我們深信只要達到每一位用戶的要求，就會得到認可，從而選擇與我們長期合作。這樣，我們也可以走得更遠！

今天，猿妹和大家分享一個教科書般的Readme——standard-readme，目前該項目在Github上已經(jīng)標(biāo)星2.3K，605個Fork。（Github地址：https://github.com/RichardLitt/standard-readme）

這個庫包含：

• 定義標(biāo)準的Readme規(guī)范
• 應(yīng)該有一個linter來維護Readme
• 創(chuàng)建標(biāo)準readme的生成器
• Badge
• 標(biāo)準Readme中的示例

標(biāo)準Readme是為開源庫設(shè)計的。盡管它以前用于Node和npm項目，但它也適用于其他語言的庫和包管理器。

背景

項目背景就是你為什么做這個項目，動機和背景是什么。當(dāng)其他開發(fā)者無需查看模塊代碼就可以使用你的項目時，你的文檔即已完成，這意味著你可以將模塊的文檔化接口與內(nèi)部實現(xiàn)分開，所以只要接口保持不變，你就可以自由更改模塊內(nèi)部代碼。

安裝

該項目需要你安裝node和npm，如下：

 
 
 
  
  
  
$ npm install --global standard-readme-spec  
 
 

Generator

使用Generator，請查看generator-standard-readme。該程序包中有一個全局可執(zhí)行文件來運行生成器，別名為standard-readme。（Github地址：https://github.com/RichardLitt/generator-standard-readme）

Badge

如果你的Readme符合標(biāo)準要求，并且你使用的是Github，那么使用Badge就會很有用，如果要以Markdown格式添加，請使用以下代碼：

 
 
 
  
  
  
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) 
 
 

維護者

你可以直接@該項目相關(guān)的維護者，這樣其他人也可以輕易聯(lián)系到他

貢獻者

創(chuàng)建一個項目不容易，最后還是要感謝一下所有的貢獻者。

License

最后的最后你需要聲明項目的開源協(xié)議，不同的開源協(xié)議的限制條件是不一樣的，這就需要你自己查閱相關(guān)條款，選擇一個最適合自己項目的開源協(xié)議。

網(wǎng)頁標(biāo)題：在Github上，怎么寫出教科書級別的readme
文章轉(zhuǎn)載：http://www.dlmjj.cn/article/ccdpdhs.html