这份《REAME 书写指南》送给不写文档的程序员
逆锋起笔
共 5838字,需浏览 12分钟
·
2020-09-12 07:34
点击上方“逆锋起笔”,公众号回复 PDF
领取大佬们推荐的学习资料
如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人,迈出成为README大师的第一步吧!(绝对不是点击诱饵)
假如你刚刚创建了很棒的项目,并在GitHub上共享了它。你认为现在你只需坐等世界告诉你这个项目有多酷。毕竟,在过去的一个月中,你为这个极具挑战性的项目付出了不懈的努力,对吗?
好吧,让我们退后一步,从检查项目的开发人员或用户的角度来看。尽管你知道自己的项目有多酷,也知道它是如何解决一个(直到你出现之前)尚未解决的紧迫问题,但是看你项目的人想知道你构建了一个什么样的世界。
如果没有人知道如何使用你的软件,那情况非常糟糕。
“哇,伙计!太棒啦!既然你知道这么多,为什么不告诉我们该怎么写……”
“我没时间做这个,快给我看README!”
-
项目标题 -
演示预览 -
目录 -
安装 -
使用方法 -
发展 -
贡献 -
赞助 -
添加新功能或修复错误 -
许可证 -
页脚
https://github.com/navendu-pottekkat/nsfw-filter/blob/master/ISSUE_TEMPLATE.md
https://towardsdatascience.com/how-to-write-an-awesome-readme-68bf4be91f8b
评论