有哪些 GitHub 项目的 README 堪称教科书?

18,079 阅读3分钟

我敢说我的GitHub开源项目,每个README都是十分规范的。

其实做项目是按照整个产品思维来梳理的。

需要在readme中说清楚几件事:

  • 这个项目是什么
  • 跟同类产品/工具有什么独特之处
  • 怎么用,更快的用起来
  • 遇到问题怎么反馈
  • 更新日志,之后的规划(可选)
  • LICENSE
  • 如何参与贡献(可选)

详细的项目README,可以参考我的这几个项目。对于想要参与开源项目,自己做开源项目,从开源项目中学习,我的GitHub很值得来看一下。

github.com/Charmve

[github.com/Charmve/Sur…

github.com/Charmve/Surface-Defect-Detection](link.zhihu.com/?target=htt…)

目前最全的工业缺陷检测数据集仓库,包含十余种类型数据集,还有最近几年缺陷检测顶会论文。

L0CV 一种结合了代码、图示和HTML的在线学习媒介

上线一周持续登陆GitHub中文榜前三!

[github.com/Charmve/com…

github.com/Charmve/computer-vision-in-action](link.zhihu.com/?target=htt…)

更多项目,在我的GitHub账号主页,repos和stars可以查看到,都为大家分类准备好了。

作为一个五年的GitHuber,真心希望开源社区越来越好!

如果你已经看到这里了,可以双击屏幕点个赞吗?我想在知乎给大家带来自动驾驶、C++、视觉感知算法相关的内容,希望做一个传播者,做一个自媒体人。谢谢!

我相信你一定会关注我的GitHub账号!2 赞同 · 1 评论文章

2022.05.31 更新

没想到这么多人关注了我的GitHub和知乎,也收到一些私信,大家的关注度还是很高的,我来更新下。大家基本都是在关注,如何具体规划,如何面试、求职。

校招和跳槽每次都会给自己多个选择,然后再去做自己的取舍。这样不至于太匆忙,太被动。校招时也收到了第一个互联网大厂的offer,美团、字节、苏宁、快手、乐鑫科技等,由于在校时一直的规划是做科研,20年毕业时找工作时间很短(三月份开始),我特别焦虑,最后集中临时抱佛脚,在面试中复习总结,全靠每场面试扩充自己的题库,这个过程中也一直总结,发布后收到了很多赞同。现在已经在GitHub和CSDN发布,leetcode

高频题和详细解题总结,八股文分类整理,有需要的可以看看:《大厂后端/算法面经分类整理》专栏概述 (字节+美团+华为+阿里等)》

[《大厂后端/算法面经分类整理》专栏概述 (字节+美团+华为+阿里等)​

blog.csdn.net/Charmve/article/details/111051085](link.zhihu.com/?target=htt…)

我本科学的是电子信息科学与技术,在校时做了很多实践项目,参加了很多大赛:电子设计竞赛、数学建模大赛、挑战杯、互联网+,还有一些机器人的比赛,也收获了不错的成绩,毕业后我把相关的资料全部整理开源至GitHub:github.com/Charmve

毕业后第一年开始转计算机视觉,也做了大量工作,论文阅读以及代码复现,开源项目等等。在GitHub的repo和stars中可以看到,现在也会长期维护,每个项目都会自己从框架到实现,亲力亲为。

所以我花了两三年时间,建立了以公众号为中心的迈微AI研习社社群,论文解读、技术分析、商业参考等文章以文字形式发布在公众号和知乎,涉及的实践项目源代码和工程管理以GitHub为中心发布,以实际软件工程化角度管理和运维。

希望这些经历和规划给大家鼓励,我也希望找到那个一同进步的人。

一个人可以走很快,但一群人可以走很远!