如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人,迈出成为README大师的第一步吧!(绝对不是点击诱饵)
假如你刚刚创建了很棒的项目,并在GitHub上共享了它。你认为现在你只需坐等世界告诉你这个项目有多酷。毕竟,在过去的一个月中,你为这个极具挑战性的项目付出了不懈的努力,对吗?
好吧,让我们退后一步,从检查项目的开发人员或用户的角度来看。尽管你知道自己的项目有多酷,也知道它是如何解决一个(直到你出现之前)尚未解决的紧迫问题,但是看你项目的人想知道你构建了一个什么样的世界。
如果没有人知道如何使用你的软件,那情况非常糟糕。
如果人们不知道你的软件是做什么的,就不会使用它或为它做出贡献,并且很可能会在开源软件的海洋中找到更清晰明了的东西。
这就是README文件的用处!
好的README文档就像是项目的外观。这是一个人在你的项目中首先要看的东西,它提供了软件的简要介绍。
美观实用的README文档可以使你的项目脱颖而出,并引起开发人员社区的关注。
这将帮助他们了解你的项目,以及它要如何使用、为什么他们应该做出贡献。
“哇,伙计!太棒啦!既然你知道这么多,为什么不告诉我们该怎么写……”
嘿,我不能说有一套具体的规则,你要努力遵守这些规则,而不是要努力写一个好的README。
它不是那样的。
我将分享我是如何为我的开源项目写README的,以及你在为项目编写README文件时应考虑的事项,这样你将(有希望)收获一些见解。
GitHub链接:
https://github.com/navendu-pottekkat
另外请记住,你不会一天之内就精通撰写README。像所有事物一样,它需要实践。
我已经为开源贡献一段时间了,我注意到所有优秀的项目都有一个很棒的READM