亚洲精品视频网,欧美日韩1级,99久视频,天天草婷婷蕉蕉操,激情网站在线,波多野结衣一区,亚洲天堂网视频网站,天天日天天干天天插

大數(shù)據(jù)文摘出品

來源：medium

編譯：青檸

如果你很著急、只是想要模板，可以直接跳到底部（但這樣一點不酷），準(zhǔn)備酷的人，邁出成為README大師的第一步吧?。ń^對不是點擊誘餌）

假如你剛剛創(chuàng)建了很棒的項目，并在GitHub上共享了它。你認為現(xiàn)在你只需坐等世界告訴你這個項目有多酷。畢竟，在過去的一個月中，你為這個極具挑戰(zhàn)性的項目付出了不懈的努力，對嗎？

好吧，讓我們退后一步，從檢查項目的開發(fā)人員或用戶的角度來看。盡管你知道自己的項目有多酷，也知道它是如何解決一個（直到你出現(xiàn)之前）尚未解決的緊迫問題，但是看你項目的人想知道你構(gòu)建了一個什么樣的世界。

如果沒有人知道如何使用你的軟件，那情況非常糟糕。

如果人們不知道你的軟件是做什么的，就不會使用它或為它做出貢獻，并且很可能會在開源軟件的海洋中找到更清晰明了的東西。

這就是README文件的用處！

好的README文檔就像是項目的外觀。這是一個人在你的項目中首先要看的東西，它提供了軟件的簡要介紹。

美觀實用的README文檔可以使你的項目脫穎而出，并引起開發(fā)人員社區(qū)的關(guān)注。

這將幫助他們了解你的項目，以及它要如何使用、為什么他們應(yīng)該做出貢獻。

“哇，伙計！太棒啦！既然你知道這么多，為什么不告訴我們該怎么寫……”

嘿，我不能說有一套具體的規(guī)則，你要努力遵守這些規(guī)則，而不是要努力寫一個好的README。

它不是那樣的。

我將分享我是如何為我的開源項目寫README的，以及你在為項目編寫README文件時應(yīng)考慮的事項，這樣你將（有希望）收獲一些見解。

GitHub鏈接：

https://github.com/navendu-pottekkat

另外請記住，你不會一天之內(nèi)就精通撰寫README。像所有事物一樣，它需要實踐。

我已經(jīng)為開源貢獻一段時間了，我注意到所有優(yōu)秀的項目都有一個很棒的README。

當(dāng)你位于項目界面時，你可以幾分鐘之內(nèi)啟動并運行你的項目版本。

有很多的貢獻者、拉取請求、頻繁發(fā)布的更新版本，都有一個很棒的README。

新的開發(fā)人員將能夠找到所有詳細信息以開始使用，例如安裝說明和貢獻指南。

新的用戶將能夠通過詳細的屏幕截圖和演示學(xué)會如何使用該項目。

“我沒時間做這個，快給我看README！”

好吧，好吧，好吧（對不起我有點像麥康納）。

以下是我的NSFW過濾項目的README，我認為這是我寫過最好的README：

https://github.com/navendu-pottekkat/nsfw-filter/blob/master/README.md

我將介紹README的不同部分，這些部分對于每個README都是必不可少的。

下面是本例中使用的README文件的鏈接。你還可以找到一個模板README，并直接復(fù)制和粘貼到項目中：

https://github.com/navendu-pottekkat/awesome-readme/tree/master

項目標(biāo)題

標(biāo)題應(yīng)具有自我解釋性，盡量不要太拗口。（當(dāng)然存在例外，像本文“超棒的開源項目README編寫指南”會是一個很酷的名字）

為你的README添加一個封面或橫幅圖片。為什么？因為它很容易引起人們的注意，而且看起來很酷。

等等，我忘了一件事。你可以將此鏈接的README用作模板：

https://towardsdatascience.com/media/README-template.md

橫幅的最佳尺寸是1280x650px。你還可以將其用于repo的社交預(yù)覽。

我個人使用Canva網(wǎng)站創(chuàng)建橫幅圖像。所有基本內(nèi)容都是免費的（在大多數(shù)情況下，你不需要專業(yè)版）。

標(biāo)題下那些華麗的東西是什么？

看起來不錯吧？這些被稱為徽章，它們通過提供一些快速見解提高了可讀性，對嗎？

你可以在你的項目中使用無數(shù)徽章，而且它們確實取決于項目。下面是我在每個項目中常用的一些。

我使用Shields IO網(wǎng)站制作徽章。這是一種簡單易用的工具，你可以使用幾乎所有的徽章：

https://shields.io

演示預(yù)覽

寫完項目后，最好對項目進行演示或預(yù)覽（視頻/ gif /屏幕截圖都是不錯的選擇），以便人們知道你的項目中會有什么。你也可以在上一節(jié)中的演示中添加產(chǎn)品說明。

這是一個隨機GIF作為占位符。

在介紹了項目之后，添加目錄是一個好主意。這將使人們可以更輕松地瀏覽你的README，并準(zhǔn)確找到他們想要的內(nèi)容。

這是一個示例目錄（哇！太酷了！），實際上是本文的目錄。

項目標(biāo)題
演示預(yù)覽
目錄
安裝
使用方法
發(fā)展
貢獻

贊助
添加新功能或修復(fù)錯誤

許可證
頁腳

安裝

你可能已經(jīng)注意到了返回頂部的按鈕（如果沒有，請注意，它就在這里?。?。這是一個好主意，因為它使README更易于瀏覽。

第一個問題應(yīng)該是如何安裝（如何使用項目或如何在機器中啟動編輯）。

這里應(yīng)該給用戶詳盡的想法，并說明他們?nèi)绾问褂庙椖縭epo的所有步驟。

按照以上步驟，他們應(yīng)該能夠在自己的設(shè)備中運行它。

我的方法是，完成README后，從頭開始閱讀這些步驟并檢查是否有效。

這是一個示例指令：

要使用此項目，請首先使用以下命令在你的設(shè)備上克隆repo：

git init

git clone

GitHub鏈接：

https://github.com/navendu-pottekkat/nsfw-filter.git

用法

這部分是可選的，用于向用戶提供安裝后如何使用項目的信息，也可以添加到“安裝”部分。

發(fā)展

在這里，你可以向開發(fā)人員說明如何修改代碼。

你可以深入說明代碼如何工作及所有內(nèi)容如何組合在一起。

你還可以提供如何設(shè)置開發(fā)環(huán)境的具體說明。

理想情況下，你應(yīng)該使README保持簡潔。如果需要添加更復(fù)雜的說明，請使用Wiki：

https://github.com/navendu-pottekkat/nsfw-filter/wiki

貢獻

在這里，你可以讓人們知道他們?nèi)绾螢槟愕捻椖孔龀鲐暙I。下面給出了一些方法。

這也顯示了如何在節(jié)中添加子節(jié)。

贊助

你的項目備受青睞，并且已經(jīng)被成千上萬的人使用（有了這個README文件，將會有更高使用量）。現(xiàn)在，是時候?qū)ふ胰藛T或組織來贊助你的項目了。

這可能是因為你沒有從項目中獲得任何收入，你需要錢來維持項目生存。

你可以在此部分中添加人們?nèi)绾钨澲愕捻椖?。在此處添加你的patreon或GitHub贊助商鏈接，以方便訪問。

一個好主意是還要向贊助商展示他們的組織徽標(biāo)或徽章，向他們表達你的愛?。傆幸惶煳視业劫澲?，并向他們表達我的愛）

添加新功能或修復(fù)錯誤

這是為了讓人們了解如何在你的項目中提出問題或提出功能要求。

你還可以為項目提交、發(fā)布或拉取請求提供指導(dǎo)。

就個人和標(biāo)準(zhǔn)而言，你應(yīng)該使用一個問題模板和拉取請求模板，以便用戶打開新問題時可以按照項目指南輕松地格式化它：

https://github.com/navendu-pottekkat/nsfw-filter/blob/master/ISSUE_TEMPLATE.md

你還可以添加聯(lián)系人詳細信息，以便人們就你的項目與你取得聯(lián)系。

許可證

將許可證添加到README是一個好習(xí)慣，這樣人們可以輕松地引用它。

確保已在項目文件夾中添加了許可證文件。快捷方式：在GitHub中單擊repo根目錄下的添加新文件-->將文件名設(shè)置為LICENSE -->GitHub顯示許可證模板--->選擇最適合項目的模板！

我個人添加了許可證名稱，并提供了指向它的鏈接，如下所示：

https://opensource.org/licenses/GPL-3.0

頁腳

我們還可以添加一個頁腳，因為我喜歡頁腳，可以使用它來傳達重要信息。

讓我們將其制作為圖像，因為到目前為止你已經(jīng)意識到圖像中的多媒體==酷（*請注意這個微妙的編程玩笑）。

就是這樣……你已經(jīng)完成了你的訓(xùn)練，小蚱蜢?，F(xiàn)在是時候?qū)⑦@些想法用于你的項目了。

當(dāng)你的項目與酷炫的README一起啟動時，不要忘記README Sensei（很酷的推特處理想法）。

如果你認為有幫助，請在GitHub上標(biāo)星號并共享本指南。

現(xiàn)在，你們一直在等待的時刻！頁腳！[喘氣]

好吧，事情就這樣結(jié)束了。

相關(guān)報道：

https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b

實習(xí)/全職編輯記者招聘ing

加入我們，親身體驗一家專業(yè)科技媒體采寫的每個細節(jié)，在最有前景的行業(yè)，和一群遍布全球最優(yōu)秀的人一起成長。坐標(biāo)北京·清華東門，在大數(shù)據(jù)文摘主頁對話頁回復(fù)“招聘”了解詳情。簡歷請直接發(fā)送至[email protected]

志愿者介紹

后臺回復(fù)“志愿者”加入我們

點「在看」的人都變好看了哦！

怎么寫一個超棒的README文檔