专业建站系统 - 打造最好的网站内容系统!

http://www.hdwhgs.com

当前位置: 青岛热点 > 互联网 > 畅行 GitHub:怎么写一个超棒的 README 文档亚博yabo官网登录 畅行 GitHub:怎么写一个超棒的 README 文档亚博yabo官网登录

畅行 GitHub:怎么写一个超棒的 README 文档亚博yabo官网登录

时间:2020-08-02来源: 作者:admin点击:
如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人,迈出成为README大师的第一步吧!(绝对不是点击诱饵)假如你刚刚创建了很棒的项目,并在GitHub上共享了它。你认为现在你只需坐等世界告诉你这个项目有多酷。毕竟,在过去的一个月中,你为这个极具挑战性的项目付出了不懈的努力,

如果您很焦急、只是想要模板,亚博yabo官网登录可能直接跳到底部(但这样一点没有酷),筹备酷的人,迈出成为 README 大师的第一步吧!(绝关于没有是点击钓饵)

假如您刚创建了很棒的名目,并在 GitHub 上共享了它。您觉得往常您只需坐等世界奉告您这个名目有多酷。毕竟,在从前的一个月中,您为这个极具挑衅性的名目付出了没有懈的努力,亚搏体亚搏体育app网站关于吗?

好吧,让咱们退后一步,从反省名目的开发职员或用户的角度来看。只管您知晓本人的名目有多酷,也知晓它是如何解决一个(直到您涌现之前)尚未解决的紧迫问题,然而看您名目的人想知晓您构建了一个什么样的世界。

如果不人知晓如何应用您的软件,那情况非常糟糕。

如果人们没有知晓您的软件是做什么的,亚博国际网页登录平台就没有会应用它或为它做出贡献,并且很可以会在开源软件的大陆中找到更明晰明了的货色。

这就是 README 文件的用处!

好的 README 文档就像是名目的外观。这是一个人在您的名目中首先要看的货色,它供给了软件的简洁介绍。

美观实用的 README 文档可能使您的名目怀才不遇,并惹起开发职员社区的关注。

这将协助他们领会您的名目,以及它要如何应用、为什么他们应该做出贡献。

“哇,伙计!太棒啦!既然您知晓这么多,亚博yaboApp官网为什么没有奉告咱们该怎么写……”

嘿,我没有能说有一套具体的规则,您要努力恪守这些规则,而没有是要努力写一个好的 README。

它没有是那样的。

我将分享我是如作甚我的开源名目写 README 的,以及您在为名目编写 README 文件时应推敲的事项,这样您将(有期冀)收成一些见解。

GitHub 链接:https://github.com/navendu-pottekkat

另外请记住,亚博直播平台APP您没有会一天之内就粗通撰写 README。像所有事物一样,它需要理论。

我已经为开源贡献一段光阴了,我注意到所有优秀的名目都有一个很棒的 README。

当您位于名目界面时,您可能多少分钟之内启动并运行您的名目版本。

有许多的贡献者、拉取要求、屡次发布的更新版本,都有一个很棒的 README。

新的开发职员将能够找到所有详细信息以开始应用,例如装置解释跟贡献指南。

新的用户将能够通过详细的屏幕截图跟演示学会如何应用该名目。

“我没光阴做这个,亚博国际老虎机手机版快给我看 README!”

好吧,好吧,好吧(关于没有起我有点像麦康纳)。

以下是我的 NSFW 过滤名目的 README,我觉得这是我写过最好的 README:https://github.com/navendu-pottekkat/nsfw-filter/blob/master/README.md

我将介绍 README 的没有同部分,这些部分对每个 README 都是必没有可少的。

下面是本例中应用的 README 文件的链接。您还可能找到一个模板 README,并直接复制跟粘贴到名目中:https://github.com/navendu-pottekkat/awesome-readme/tree/master

名目标题

标题应存在自我阐明性,yabo亚博登录尽量没有要太拗口。(当然具备例外,像本文 “超棒的开源名目 README 编写指南”会是一个很酷的名字)

为您的 README 增加一个封面或横幅图片。为什么?因为它很等闲惹起人们的注意,而且看起来很酷。

等等,我忘了一件事。您可能将此链接的 README 用作模板:https://towardsdatascience.com/media/README-template.md

横幅的最佳尺寸是 1280x650px。您还可能将其用于 repo 的社交预览。

我个人应用 Canva 网站创建横幅图像。所有基础内容都是免费的(在大多数情况下,您没有需要专业版)。

标题下那些华丽的货色是什么?

看起来没有错吧?这些被称为徽章,它们通过供给一些神速见解进步了可读性,yabo手机版登录关于吗?

您可能在您的名目中应用无数徽章,而且它们的确取决于名目。下面是我在每个名目中常用的一些。

我应用 Shields IO 网站制作徽章。这是一种简单易用的工具,您可能应用多少乎所有的徽章:https://shields.io

演示预览

写完名目后,最好关于名目进行演示或预览(视频 / gif / 屏幕截图都是没有错的选择),以便人们知晓您的名目中会有什么。您也可能在上一节中的演示中增加产品解释。

这是一个随机 GIF 作为占位符。

目录

在介绍了名目之后,增加目录是一个好设法。这将使人们可能更轻松地阅读您的 README,并精确找到他们想要的内容。

这是一个示例目录(哇!太酷了!),实践上是本文的目录。

名目标题

演示预览

目录

装置

应用行动

开展

贡献

帮助

增加新功用或修复分歧同伴

容许证

页脚

装置

您可以已经注意到了返回顶部的按钮(如果不,请注意,它就在这里!)。这是一个好设法,因为它使 README 更易于阅读。

第一个问题应该是如何装置(如何应用名目或如何在机器中启动编辑)。

这里应该给用户详尽的想法,并解释他们如何应用名目 repo 的所有步骤。

依照以上步骤,他们应该能够在本人的装备中运行它。

我的行动是,实现 README 后,从头开始涉猎这些步骤并反省能否有效。

这是一个示例指令:

要应用此名目,请首先应用以下命令在您的装备上克隆

git init 

git clone

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

用法

这部分是可选的,用于向用户供给装置后如何应用名目的信息,也可能增加到 “装置”部分。

开展

在这里,您可能向开发职员解释如何改动代码。

您可能深化解释代码如何工作及所有内容如何组合在一起。

您还可能供给如何设置开发环境的具体解释。

空想情况下,您应该使 README 维持简明。如果需要增加更冗长的解释,请应用 Wiki:https://github.com/navendu-pottekkat/nsfw-filter/wiki

贡献

在这里,您可能让人们知晓他们如作甚您的名目做出贡献。下面给出了一些行动。

这也显示了如何在节中增加子节。

帮助

您的名目备受青眼,并且已经被浩如烟海的人应用(有了这个 README 文件,将会有更高应用量)。往常,是时分寻觅职员或组织来帮助您的名目了。

这可以是因为您不从名目中获得任何收入,您需要钱来保持名目生存。

您可能在此部分中增加人们如何帮助您的名目。在此处增加您的 patreon 或 GitHub 帮助商链接,以便当造访。

一个好设法是还要向帮助商展示他们的组织徽标或徽章,向他们表白您的爱!(总有一天我会找到帮助商,并向他们表白我的爱)

增加新功用或修复分歧同伴

这是为了让人们领会如何在您的名目中提出问题或提出功用请求。

您还可能为名目提交、发布或拉取要求供给指导。

就个人跟规范而言,您应该应用一个问题模板跟拉取要求模板,以便用户打开新问题时可能依照名目指南轻松地款式化它:https://github.com/navendu-pottekkat/nsfw-filter/blob/master/ISSUE_TEMPLATE.md

您还可能增加联系人详细信息,以便人们就您的名目与您失掉联系。

容许证

将容许证增加到 README 是一个好习气,这样人们可能轻松地引用它。

确保已在名目文件夹中增加了容许证文件。倏地办法:在 GitHub 中单击 repo 根目录下的增加新文件 -->将文件名设置为 LICENSE -->GitHub 显示容许证模板 --->选择最适合名目的模板!

我个人增加了容许证称号,并供给了指向它的链接,如下所示:https://opensource.org/licenses/GPL-3.0

页脚

咱们还可能增加一个页脚,因为我爱好页脚,可能应用它来转达首要信息。

让咱们将其制作为图像,因为到目前为止您已经认识到图像中的多媒体 == 酷(* 请注意这个奥妙的编程玩笑)。

就是这样…… 您已经实现了您的训练,小蚱蜢。往常是时分将这些想法用于您的名目了。

当您的名目与酷炫的 README 一起启动时,没有要忘怀 README Sensei(很酷的推特处空想法)。

如果您觉得有协助,请在 GitHub 上标星号并共享本指南。

往常,您们没有时在期待的时辰!页脚![喘气]

好吧,事件就这样完毕了。

------分隔线----------------------------
相关内容
推荐内容