如何清晰展示 GitHub 项目

firemail

A well-organized project

有一个项目简介文件

项目简介文件可以提供：

• 项目目标
• 截屏或视频
• 使用说明
• 软件下载页面
  
  

在简介文件里面放软件界面截屏

一张图比一千个字更能说明问题。

人们不会因为要看软件界面就去安装软件。请提供软件界面截图。

在简介中放视频

一张图能抵一千个字，那么一个视频顶一千张图。

注意：GitHub不允许插入视频，你可以使用动态图。

网页链接或安装文件链接

如果该项目是网络应用，请提供网页地址。当然，所有人都应该能访问该地址。

如果该项目是单机程序，请提供安装文件下载地址。如果安装文件看上去不专业，用户是不会安装它的。很多时候，是否专业跟发布方式有关。

整合GitHub工具

GitHub提供了一整套免费工具用于编连，打包，测试和其他功能。这些工具在专业软件开发中都是必须的。

以前想要实现这些功能非常困难，但如今通过GitHub一切都非常简单。你没有理由不用它们。

这是一个由C++实现的四子棋的例子。按钮从左到右代表：

• 在Linux上编连（Travis CI）
• 在Windows上编连（AppVeyor）
• 单元测试和测试覆盖分析（Coveralls）