在Github上，怎么寫出教科書級(jí)別的readme
很多開發(fā)者在Github上創(chuàng)建一個(gè)項(xiàng)目的時(shí)候，往往忽視了Readme的重要性，實(shí)際上，Readme文件通常是你開源項(xiàng)目的第一個(gè)入口點(diǎn)，它的作用主要有告訴人們?yōu)槭裁磻?yīng)該使用你的項(xiàng)目，以及如何安裝和使用，一份標(biāo)準(zhǔn)化的Readme可以簡(jiǎn)化它的創(chuàng)建和維護(hù)，所以Readme值得你花時(shí)間去創(chuàng)建。
今天，猿妹和大家分享一個(gè)教科書般的Readme——standard-readme，目前該項(xiàng)目在Github上已經(jīng)標(biāo)星2.3K，605個(gè)Fork。（Github地址：https://github.com/RichardLitt/standard-readme）
這個(gè)庫包含：
- 定義標(biāo)準(zhǔn)的Readme規(guī)范
- 應(yīng)該有一個(gè)linter來維護(hù)Readme
- 創(chuàng)建標(biāo)準(zhǔn)readme的生成器
- Badge
- 標(biāo)準(zhǔn)Readme中的示例
標(biāo)準(zhǔn)Readme是為開源庫設(shè)計(jì)的。盡管它以前用于Node和npm項(xiàng)目，但它也適用于其他語言的庫和包管理器。
背景
項(xiàng)目背景就是你為什么做這個(gè)項(xiàng)目，動(dòng)機(jī)和背景是什么。當(dāng)其他開發(fā)者無需查看模塊代碼就可以使用你的項(xiàng)目時(shí)，你的文檔即已完成，這意味著你可以將模塊的文檔化接口與內(nèi)部實(shí)現(xiàn)分開，所以只要接口保持不變，你就可以自由更改模塊內(nèi)部代碼。
安裝
該項(xiàng)目需要你安裝node和npm，如下：
- $ npm install --global standard-readme-spec
Generator
使用Generator，請(qǐng)查看generator-standard-readme。該程序包中有一個(gè)全局可執(zhí)行文件來運(yùn)行生成器，別名為standard-readme。（Github地址：https://github.com/RichardLitt/generator-standard-readme）
Badge
如果你的Readme符合標(biāo)準(zhǔn)要求，并且你使用的是Github，那么使用Badge就會(huì)很有用，如果要以Markdown格式添加，請(qǐng)使用以下代碼：
- [](https://github.com/RichardLitt/standard-readme)
維護(hù)者
你可以直接@該項(xiàng)目相關(guān)的維護(hù)者，這樣其他人也可以輕易聯(lián)系到他
貢獻(xiàn)者
創(chuàng)建一個(gè)項(xiàng)目不容易，最后還是要感謝一下所有的貢獻(xiàn)者。
License
最后的最后你需要聲明項(xiàng)目的開源協(xié)議，不同的開源協(xié)議的限制條件是不一樣的，這就需要你自己查閱相關(guān)條款，選擇一個(gè)最適合自己項(xiàng)目的開源協(xié)議。
