點(diǎn)擊上方“逆鋒起筆”，公眾號(hào)回復(fù) PDF
領(lǐng)取大佬們推薦的學(xué)習(xí)資料
如果你很著急、只是想要模板，可以直接跳到底部（但這樣一點(diǎn)不酷），準(zhǔn)備酷的人，邁出成為README大師的第一步吧?。ń^對(duì)不是點(diǎn)擊誘餌）
假如你剛剛創(chuàng)建了很棒的項(xiàng)目，并在GitHub上共享了它。你認(rèn)為現(xiàn)在你只需坐等世界告訴你這個(gè)項(xiàng)目有多酷。畢竟，在過(guò)去的一個(gè)月中，你為這個(gè)極具挑戰(zhàn)性的項(xiàng)目付出了不懈的努力，對(duì)嗎？
好吧，讓我們退后一步，從檢查項(xiàng)目的開(kāi)發(fā)人員或用戶的角度來(lái)看。盡管你知道自己的項(xiàng)目有多酷，也知道它是如何解決一個(gè)（直到你出現(xiàn)之前）尚未解決的緊迫問(wèn)題，但是看你項(xiàng)目的人想知道你構(gòu)建了一個(gè)什么樣的世界。
如果沒(méi)有人知道如何使用你的軟件，那情況非常糟糕。
如果人們不知道你的軟件是做什么的，就不會(huì)使用它或?yàn)樗龀鲐暙I(xiàn)，并且很可能會(huì)在開(kāi)源軟件的海洋中找到更清晰明了的東西。
好的README文檔就像是項(xiàng)目的外觀。這是一個(gè)人在你的項(xiàng)目中首先要看的東西，它提供了軟件的簡(jiǎn)要介紹。
美觀實(shí)用的README文檔可以使你的項(xiàng)目脫穎而出，并引起開(kāi)發(fā)人員社區(qū)的關(guān)注。
這將幫助他們了解你的項(xiàng)目，以及它要如何使用、為什么他們應(yīng)該做出貢獻(xiàn)。
“哇，伙計(jì)！太棒啦！既然你知道這么多，為什么不告訴我們?cè)撛趺磳?xiě)……”
嘿，我不能說(shuō)有一套具體的規(guī)則，你要努力遵守這些規(guī)則，而不是要努力寫(xiě)一個(gè)好的README。
我將分享我是如何為我的開(kāi)源項(xiàng)目寫(xiě)README的，以及你在為項(xiàng)目編寫(xiě)README文件時(shí)應(yīng)考慮的事項(xiàng)，這樣你將（有希望）收獲一些見(jiàn)解。
https://github.com/navendu-pottekkat
另外請(qǐng)記住，你不會(huì)一天之內(nèi)就精通撰寫(xiě)README。像所有事物一樣，它需要實(shí)踐。
我已經(jīng)為開(kāi)源貢獻(xiàn)一段時(shí)間了，我注意到所有優(yōu)秀的項(xiàng)目都有一個(gè)很棒的README。
當(dāng)你位于項(xiàng)目界面時(shí)，你可以幾分鐘之內(nèi)啟動(dòng)并運(yùn)行你的項(xiàng)目版本。
有很多的貢獻(xiàn)者、拉取請(qǐng)求、頻繁發(fā)布的更新版本，都有一個(gè)很棒的README。
新的開(kāi)發(fā)人員將能夠找到所有詳細(xì)信息以開(kāi)始使用，例如安裝說(shuō)明和貢獻(xiàn)指南。
新的用戶將能夠通過(guò)詳細(xì)的屏幕截圖和演示學(xué)會(huì)如何使用該項(xiàng)目。
“我沒(méi)時(shí)間做這個(gè)，快給我看README！”
好吧，好吧，好吧（對(duì)不起我有點(diǎn)像麥康納）。
以下是我的NSFW過(guò)濾項(xiàng)目的README，我認(rèn)為這是我寫(xiě)過(guò)最好的README：
https://github.com/navendu-pottekkat/nsfw-filter/blob/master/README.md
我將介紹README的不同部分，這些部分對(duì)于每個(gè)README都是必不可少的。
下面是本例中使用的README文件的鏈接。你還可以找到一個(gè)模板README，并直接復(fù)制和粘貼到項(xiàng)目中：
https://github.com/navendu-pottekkat/awesome-readme/tree/master
標(biāo)題應(yīng)具有自我解釋性，盡量不要太拗口。 （當(dāng)然存在例外，像本文“超棒的開(kāi)源項(xiàng)目README編寫(xiě)指南”會(huì)是一個(gè)很酷的名字）
為你的README添加一個(gè)封面或橫幅圖片。為什么？因?yàn)樗苋菀滓鹑藗兊淖⒁?，而且看起?lái)很酷。
等等，我忘了一件事。你可以將此鏈接的README用作模板：
https://towardsdatascience.com/media/README-template.md
橫幅的最佳尺寸是1280x650px。你還可以將其用于repo的社交預(yù)覽。
我個(gè)人使用Canva網(wǎng)站創(chuàng)建橫幅圖像。所有基本內(nèi)容都是免費(fèi)的（在大多數(shù)情況下，你不需要專業(yè)版）。
看起來(lái)不錯(cuò)吧？這些被稱為徽章，它們通過(guò)提供一些快速見(jiàn)解提高了可讀性，對(duì)嗎？
你可以在你的項(xiàng)目中使用無(wú)數(shù)徽章，而且它們確實(shí)取決于項(xiàng)目。下面是我在每個(gè)項(xiàng)目中常用的一些。
我使用Shields IO網(wǎng)站制作徽章。這是一種簡(jiǎn)單易用的工具，你可以使用幾乎所有的徽章：
寫(xiě)完項(xiàng)目后，最好對(duì)項(xiàng)目進(jìn)行演示或預(yù)覽（視頻/ gif /屏幕截圖都是不錯(cuò)的選擇），以便人們知道你的項(xiàng)目中會(huì)有什么。你也可以在上一節(jié)中的演示中添加產(chǎn)品說(shuō)明。
在介紹了項(xiàng)目之后，添加目錄是一個(gè)好主意。這將使人們可以更輕松地瀏覽你的README，并準(zhǔn)確找到他們想要的內(nèi)容。關(guān)注公眾號(hào) 逆鋒起筆，回復(fù) pdf，下載你需要的各種學(xué)習(xí)資料。
這是一個(gè)示例目錄（哇！太酷了?。?，實(shí)際上是本文的目錄。
你可能已經(jīng)注意到了返回頂部的按鈕（如果沒(méi)有，請(qǐng)注意，它就在這里?。＿@是一個(gè)好主意，因?yàn)樗筊EADME更易于瀏覽。
第一個(gè)問(wèn)題應(yīng)該是如何安裝（如何使用項(xiàng)目或如何在機(jī)器中啟動(dòng)編輯）。
這里應(yīng)該給用戶詳盡的想法，并說(shuō)明他們?nèi)绾问褂庙?xiàng)目repo的所有步驟。
按照以上步驟，他們應(yīng)該能夠在自己的設(shè)備中運(yùn)行它。
我的方法是，完成README后，從頭開(kāi)始閱讀這些步驟并檢查是否有效。
要使用此項(xiàng)目，請(qǐng)首先使用以下命令在你的設(shè)備上克隆repo：
https://github.com/navendu-pottekkat/nsfw-filter.git
這部分是可選的，用于向用戶提供安裝后如何使用項(xiàng)目的信息，也可以添加到“安裝”部分。
在這里，你可以向開(kāi)發(fā)人員說(shuō)明如何修改代碼。
你可以深入說(shuō)明代碼如何工作及所有內(nèi)容如何組合在一起。
你還可以提供如何設(shè)置開(kāi)發(fā)環(huán)境的具體說(shuō)明。
理想情況下，你應(yīng)該使README保持簡(jiǎn)潔。如果需要添加更復(fù)雜的說(shuō)明，請(qǐng)使用Wiki：
https://github.com/navendu-pottekkat/nsfw-filter/wiki
在這里，你可以讓人們知道他們?nèi)绾螢槟愕捻?xiàng)目做出貢獻(xiàn)。下面給出了一些方法。
這也顯示了如何在節(jié)中添加子節(jié)。
你的項(xiàng)目備受青睞，并且已經(jīng)被成千上萬(wàn)的人使用（有了這個(gè)README文件，將會(huì)有更高使用量）?，F(xiàn)在，是時(shí)候?qū)ふ胰藛T或組織來(lái)贊助你的項(xiàng)目了。
這可能是因?yàn)槟銢](méi)有從項(xiàng)目中獲得任何收入，你需要錢來(lái)維持項(xiàng)目生存。
你可以在此部分中添加人們?nèi)绾钨澲愕捻?xiàng)目。在此處添加你的patreon或GitHub贊助商鏈接，以方便訪問(wèn)。
一個(gè)好主意是還要向贊助商展示他們的組織徽標(biāo)或徽章，向他們表達(dá)你的愛(ài)！（總有一天我會(huì)找到贊助商，并向他們表達(dá)我的愛(ài)）
這是為了讓人們了解如何在你的項(xiàng)目中提出問(wèn)題或提出功能要求。
你還可以為項(xiàng)目提交、發(fā)布或拉取請(qǐng)求提供指導(dǎo)。
就個(gè)人和標(biāo)準(zhǔn)而言，你應(yīng)該使用一個(gè)問(wèn)題模板和拉取請(qǐng)求模板，以便用戶打開(kāi)新問(wèn)題時(shí)可以按照項(xiàng)目指南輕松地格式化它：
https://github.com/navendu-pottekkat/nsfw-filter/blob/master/ISSUE_TEMPLATE.md
你還可以添加聯(lián)系人詳細(xì)信息，以便人們就你的項(xiàng)目與你取得聯(lián)系。
將許可證添加到README是一個(gè)好習(xí)慣，這樣人們可以輕松地引用它。
確保已在項(xiàng)目文件夾中添加了許可證文件?？旖莘绞剑涸贕itHub中單擊repo根目錄下的添加新文件-->將文件名設(shè)置為L(zhǎng)ICENSE -->GitHub顯示許可證模板--->選擇最適合項(xiàng)目的模板！
我個(gè)人添加了許可證名稱，并提供了指向它的鏈接，如下所示：
https://opensource.org/licenses/GPL-3.0
我們還可以添加一個(gè)頁(yè)腳，因?yàn)槲蚁矚g頁(yè)腳，可以使用它來(lái)傳達(dá)重要信息。
讓我們將其制作為圖像，因?yàn)榈侥壳盀橹鼓阋呀?jīng)意識(shí)到圖像中的多媒體==酷（*請(qǐng)注意這個(gè)微妙的編程玩笑）。
就是這樣……你已經(jīng)完成了你的訓(xùn)練，小蚱蜢?，F(xiàn)在是時(shí)候?qū)⑦@些想法用于你的項(xiàng)目了。
當(dāng)你的項(xiàng)目與酷炫的README一起啟動(dòng)時(shí)，不要忘記README Sensei（很酷的推特處理想法）。
如果你認(rèn)為有幫助，請(qǐng)?jiān)贕itHub上標(biāo)星號(hào)并共享本指南。
現(xiàn)在，你們一直在等待的時(shí)刻！頁(yè)腳！[喘氣]
https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b
如果你也有好的開(kāi)源項(xiàng)目，歡迎推薦！
Pandas官方文檔中文版下載、圖形深度學(xué)習(xí) PPT 下載
谷歌的這個(gè)開(kāi)源項(xiàng)目霸榜 Github 第一，我服了！
