开源项目中标准文件命名和实践

本文主要整理下针对开源项目中标准文件分类及其主要功能说明。

下面几个是标准的顶级文件命名（并不是每个发行版本都需要所有文件）。

README或README.md

最先被阅读的文件，通常包含项目整体的介绍以及通用的说明。

INSTALL

配置、编译和安装指导。

AUTHORS

项目贡献者列表（GNU惯例）。

NEWS

最近的项目新闻。

HISTORY

项目历史。

CHANGES

修改版本之间重大更改的日志。

COPYING

项目许可证条款（GNU惯例）。

LICENSE

项目许可证条款。

FAQ

项目常见问题解答的纯文本文档。

整体习惯上一律使用大写字母。

README文件功能及创建规则

README应该短小精简容易阅读。确保只是一份介绍，而不是长篇累牍。通常建议包含以下内容：

项目的简短描述。

项目站点链接。

开发者编译环境注意事项及潜在的移植性问题。

描述重要文件和子目录的说明。

编译及安装的指令或指向同样的内容（通常是INSTALL文件）。

维护者列表或者指向同样的内容（通常是CREDITS文件）。

项目的最近新闻或者指向同样内容的文件（通常是NEWS文件）。

项目邮件列表或者FAQ地址。

说明

本文主要参考《Unix编程艺术》第19章，以及wiki README。

内容不是最新的，只是感觉可以作为后续学习、接触及了解开源项目的基础。