好的开源项目一定要有一个好的示例

作为一个开源项目,如果没有一个好的 example,用户是很难上手的,比较知名的项目基本都有提供,所以我在项目中也加入了一个示例。本项目是基于 Go 进行开发的。

这个示例主要是通过一个用户模块来了解项目中的各层之间如何进行协作,具体如何使用。

项目地址:https://github.com/1024casts/snake

该用户模块包含以下功能:

通过该模块可以学到该框架的如下用法:

通过阅读项目中的代码即可了解具体的实现。

大家的开源项目中有提供示例么?

如果大家有任何问题或者建议,欢迎一起交流、讨论、提 PR。
喜欢的话给来个 Star: https://github.com/1024casts/snake

  • golang

    Go 语言是 Google 推出的一种全新的编程语言,可以在不损失应用程序性能的情况下降低代码的复杂性。谷歌首席软件工程师罗布派克(Rob Pike)说:我们之所以开发 Go,是因为过去 10 多年间软件开发的难度令人沮丧。Go 是谷歌 2009 发布的第二款编程语言。

    413 引用 • 1322 回帖 • 683 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    313 引用 • 3140 回帖 • 715 关注

赞助商 我要投放

7 回帖
请输入回帖内容 ...
  • 88250 1 评论

    能提供示例尽量提供,面向 CV 工程师直接使用 😅

    1 回复
    补充一下,我不是看不起 CV 工程师啊,主要表达的观点是示例完善可以节省使用者时间。我自己就是一个地道的 CV 工程师 😂
    88250 1
  • qloog

    CV 是什么?

    1 回复
  • 88250

    复制粘贴 😂

    1 回复
  • qloog

    😄 ,soga

  • imlinhanchao

    还有一点,工具类的要按版本发布成品在 release。经常遇到进去 release 都是 source code。得拉代码自己编译,马上关闭页面。doge

  • imlinhanchao

    我的开源项目基本上都提供脚本可以直接部署和配置(Web 项目)。比如:https://github.com/imlinhanchao/librejo

  • zerosoul

    赞同

    比如当初我做的这个弹幕类库:https://zerosoul.github.io/rc-bullets/ 先有的 demo,后有的类库代码,哈哈哈哈哈。

请输入回帖内容 ...