这是一个例子,关于如何开源一个项目。
提供一个例子关于如何使用你的开源项目。
我们应该创建下面的这些文件:
- .gitignore
开源项目根目录配置忽略哪些文件提交
- .mailmap
提供项目开源支持的邮件列表
- .gitattributes
确保文件可以被正确对待
- CONTRIBUTING.md
如果下载,编译,导入开源项目到你的IDE里面。
- LICENSE
我们最好为我们当前开源的项目提供一个软件证书。
例如,当前项目正在使用 Apache Licence 2.0.
如果想知道更多关于证书的知识或选择其他的软件证书,可以看看这篇文章:
[如何选择免费的开源证书](http://www.ruanyifeng.com/blog/2011/05/how_to_choose_free_software_licenses.html)
- README.md
关于这个项目的英文介绍
- README_zh.md
关于这个项目的中文介绍
提供一些信息关于如何编译构建这个开源项目
提供信息如何部署这个项目
提供信息如何运行这个项目
提供信息是谁在为这个项目做出贡献。