嵌入式工程师如何用好GitHub

由 judy 提交于周一, 12 十一月 2018 - 11:01

这年头GitHub可谓是程序员必备交友技能。毫无疑问GitHub现在已经是全球最大的开源社区了，也常常被人戏称为“全球最大同性交友平台”。

你可以在这里follow各种开源社区的技术大牛，学习到各种各样的开源技术和开源项目。

那么作为一个嵌入式工程师，我们应该如何用好GitHub呢？GitHub可以用来做些什么好玩有意思的事情呢？

追随开源项目

要说在嵌入式方面应用最广的是什么，大家一定不会忽略Linux。

在GitHub上我们可以很轻松地找到Linus Torvald的linux项目 https://github.com/torvalds/linux 。

除此之外硬件厂商往往会在GitHub上推出给自家硬件适配的linux驱动源代码，还可以找到
  •   树莓派社区官方维护的 https://github.com/raspberrypi/linux
  •   Xilinx官方维护的linux项目 https://github.com/Xilinx/linux-xlnx
  •   devicetree项目 https://github.com/Xilinx/device-tree-xlnx 以及
  •   uboot项目 https://github.com/Xilinx/u-boot-xlnx
  •   当然了，你也可以在GitHub上找到我们的 PYNQ 项目 https://github.com/Xilinx/PYNQ
<center><img width="600" src="http://xilinx.eetrend.com/files-eetrend-xilinx/blog/201811/13872-40579-…; alt="嵌入式工程师如何用好GitHub"></center>

开源社区有一句老话叫做，不要重复发明轮子。

拿来主义在开源社区是天经地义的，站在巨人的肩膀上才能站得更高，才能继续为开源的事业添砖加瓦更上一层楼。

我们可以看到目前GitHub中已经有222个关于PYNQ的开源项目，它们都是在PYNQ项目的基础上进一步开发的。

搭建个人网站

经常看到有人的简历上挂着一个github.io结尾的网站，点开一份是一个很酷炫的电子版简历，这就是GitHub提供的免费静态网站托管业务。

这个叫GitHub Pages的业务不仅不需要花钱，还免费赠送一个与你用户名相关的域名，也可以绑定自己的域名。

八仙过海各显神通，有人用它来放置自己的简历，有人在上面写写博客，当一个免费的博客使，http://www.zynqnotes.com/ 就是一个典型的在GitHub上托管的个人博客。

收藏夹资料库

GitHub上有许多有趣好玩的项目，我们可以通过"star"操作，建立起自己的一个收藏夹。

也可以通过“fork”操作，将所有自己感兴趣的收藏到自己的账号之下，建立一套资料库。

存放项目文档

一个成型的项目往往都有一份清晰明了的文档。

除了自己购买服务器专门搭建一个项目文档网站之外，也可以直接在GitHub上存放项目文档的源文件，然后使用一些第三方文档生成工具来生成文档。

这样的好处是文档可以跟项目代码一起存放，方便追溯和管理。

同样以我们的PYNQ项目为例，所有的文档文件都存放在docs文件夹中。使用第三方文档托管系统readthedocs，从docs文件夹中存放的文档自动生成PYNQ静态文档网站 https://pynq.readthedocs.io 。
<center><img width="600" src="http://xilinx.eetrend.com/files-eetrend-xilinx/blog/201811/13872-40581-…; alt="嵌入式工程师如何用好GitHub"></center>

协作翻译文档

如果你想要清清爽爽地开始写点技术文档，不需要操心过多格式相关的问题，或者伙同二三好友一起翻译一篇英文文档/书籍，GitHub+GitBook恐怕是你最好的选择了。

GitHub负责存放和追踪电子书文档，GitBook获取了你的项目授权之后就会自动同步文档到GitBook网站中，按照简单不复杂的排版格式，把你写的技术文档整整齐齐的排列在一起。

我们之前就做过协作翻译英文版电子书的项目，英文名叫做《Parallel Programming for FPGAs》，翻译过来叫做《FPGA并行编程》。

项目存放在 https://github.com/xupsh/pp4fpgas-cn 上，最后生成的电子书就在GitBook网站上 https://xupsh.gitbook.io/pp4fpgas-cn/ ，点击 https://xupsh.gitbook.io/pp4fpgas-cn/ 就可以看到这本电子书了。