既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上Go语言开发知识点,真正体系化!
由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频,并且后续会持续更新
您也可以在贡献者名单中参看所有参与该项目的开发者。
版权说明
该项目签署了MIT 授权许可,详情请参阅***LICENSE.md***
鸣谢
该项目参考了XXX的 XXX
灵感来源于XXX
感谢女友的支持和陪伴
以上。其实在实际的写作当中,也并不一定要完全跟着这个框架来,可以根据项目情况进行增删。比如稍微复杂点的项目,就要更多的纬度去说明,那么在开头就需要列出目录(Table Of Content)。另外,图片展示也是一种常用的手段,适当地放图片,会让你的文档更有趣味。
关于README的写作,这里还有一份非常全面的学习资源:https://github.com/matiassingers/awesome-readme,大家也可以多多参考学习。
GitHub 项目堪称教科书的 README,那一定要推荐 Standard Readme。
看名字你应该就知道这是什么了,就是标准 README 应该写哪些内容,应该怎样排版等等。
先放上链接:
RichardLitt/standard-readmegithub.com/RichardLitt/standard-readme
这个 README 标准是由 RichardLitt 发起,十多名开发者共同贡献完成的,在 GitHub 上有 1230+ Star。
你的 README 文件通常是你开源项目的第一个入口点。你应该通过 README 明确地告诉大家,为什么他们应该使用你的项目,他们如何安装它,以及他们如何使用它。
因此我相信很多人急需一份标准化的 README 编写方式,帮助你更轻松地创建和维护 REAMDME。所以 Standard Readme 这个项目就诞生了。
一个标准的 README 应该包含哪些内容呢:
- 项目背景
- 安装
- 使用
- Badge
- 相关项目(可选)
- 主要项目负责人
- 参与贡献方式
- 开源协议
项目背景很简单,就是你为什么做这个项目,动机和背景是什么。
安装和使用也很简单,清晰明了即可,例如:
Badge 是一个很好玩的东西,当然是可选的,非必须。如下图:
相关项目就是还有哪些与你做的类似的项目,如果你感兴趣可以列出来,例如:
项目主要负责人可以通过很多方式展现出来,直接艾特标注是最简单的方式:
参与贡献方式就是写清楚大家可以怎样参与这个项目的贡献,可简单,可繁琐,例如:
License 就是你这个项目的开源协议,具体可以阅读协议介绍去选择一款适合你的:
以上就是一个 GitHub 项目的 README 应该具备的内容,这个回答对你有帮助的话就点个赞吧~
先引用我在 《GitHub 漫游指南 - github-roam》相关部分的文章。在一个开源项目里,README 是最重要的内容。它快速地介绍了这个项目,并决定了它能不能吸引用户:
- 这个项目做什么?
- 它解决了什么问题
- 它有什么特性 — hello, world 示例
这个项目做什么——一句话文案
GitHub 的 Description 是我们在 Hacking News、GitHub Trneding 等等,第一时间看到的介绍。也是我们能快速介绍给别人的东西,如下图所示:
这一句话,必须简单明了也介绍,它是干什么的。
如 Angular 的一句话方案是:One framework. Mobile & desktop.
而 React 是:A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue 则是:A progressive, incrementally-adoptable JavaScript framework for building UI on the web.
它解决了什么问题
上面的一句话描述,它不能很好地说明,它能解决什么问题。
如下是今天在 GitHub Trending 上榜的 RPC 项目的简介:
Most machines on internet communicate with each other via TCP/IP. However TCP/IP only guarantees reliable data transmissions, we need to abstract more to build services:
以上便是这个项目能解决的问题,不过这个项目能解决的问题倒是比较长,哈哈哈。
它有什么特性
当我们有 A、B、C 几个不同的框架的时候,作为一个开发人员,就需要对比他们的特性,。如下是 Go 语言实现的 MQTT 示例:
这个项目只支持的 Qos 级别为 0。如果我们需要的级别是 1,那么就不能用这个项目了。
又比如 lodash 项目:
Lodash makes JavaScript easier by taking the hassle out of working with arrays, numbers, objects, strings, etc. Lodash’s modular methods are great for:
- Iterating arrays, objects, & strings
- Manipulating & testing values
- Creating composite functions
你会怎么写?脸皮够厚的话,可以直接写一下,与其它项目的对比,blabla:
当然了,这种事不能太过,要不然会招来一堆黑。
安装及hello, world 示例
在我们看完了上面的介绍之后,紧接着接一个 hello, world 的示例。在运行 hello, world 之前,我们可能需要一些额外的安装工作,如:
npm install koa
如 Koa 的示例:
const Koa = require('koa');
const app = new Koa();
// response
app.use(ctx => {
ctx.body = 'Hello Koa';
});
app.listen(3000);
作为一个程序员,你应该懂得它的重要性。
好在这里的安装工作只有两步,而不是:
对于那些需要复杂的安装过程的软件,应该简化安装过程,如提供 Docker 镜像,或者直接提供一个可运行的 Demo 环境。以免用户在看完 README 之后,直接放弃了使用该库。
基于上述的标准,我觉得我用过的这几个不错
不过,现今的趋势是引流到自己的官网上,这样可以获得流量、品牌效应和广告费等等。如 Angular、React、Vue 就这样成了 README 不好的例子
我敢说我的GitHub开源项目,每个README都是十分规范的。
其实做项目是按照整个产品思维来梳理的。
需要在readme中说清楚几件事:
- 这个项目是什么
- 跟同类产品/工具有什么独特之处
- 怎么用,更快的用起来
- 遇到问题怎么反馈
- 更新日志,之后的规划(可选)
- LICENSE
- 如何参与贡献(可选)
详细的项目README,可以参考我的这几个项目。对于想要参与开源项目,自己做开源项目,从开源项目中学习,我的GitHub很值得来看一下。
https://github.com/Charmve/Surface-Defect-Detectiongithub.com/Charmve/Surface-Defect-Detection
目前最全的工业缺陷检测数据集仓库,包含十余种类型数据集,还有最近几年缺陷检测顶会论文。
L0CV https://charmve.github.io/L0CV-web/
一种结合了代码、图示和HTML的在线学习媒介
上线一周持续登陆GitHub中文榜前三!
https://github.com/Charmve/computer-vision-in-actiongithub.com/Charmve/computer-vision-in-action
更多项目,在我的GitHub账号主页,repos和stars可以查看到,都为大家分类准备好了。
作为一个五年的GitHuber,真心希望开源社区越来越好!
针对中文,演示Markdown的各种语法
具体的项目效果可以参考:https://github.com/guoyunsky/Markdown-Chinese-Demo
大标题
大标题一般显示工程名,类似html的
你只要在标题下面跟上=====即可
中标题
中标题一般显示重点项,类似html的
你只要在标题下面输入------即可
小标题
小标题类似html的
小标题的格式如下 ### 小标题
注意#和标题字符中间要有空格
注意!!!下面所有语法的提示我都先用小标题提醒了!!!
单行文本框
这是一个单行的文本框,只要两个Tab再输入文字即可
多行文本框
![img](https://img-blog.csdnimg.cn/img_convert/506b572854510ab428dfdff5a218b007.png)
![img](https://img-blog.csdnimg.cn/img_convert/af7d9b1d9337a95fa3b8ab3212a23a01.png)
**网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**
**[需要这份系统化的资料的朋友,可以添加戳这里获取](https://bbs.csdn.net/topics/618658159)**
**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**
醒了!!!
#### 单行文本框
这是一个单行的文本框,只要两个Tab再输入文字即可
#### 多行文本框
[外链图片转存中…(img-nkA0dhRw-1715894834891)]
[外链图片转存中…(img-WoWiLMQh-1715894834891)]
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!