README文件内容

[codcodog]

README文件内容

README文件应该短小精简容易阅读。确保只是一份介绍，而不是长篇类牍。在README文件中应该包括如下的良好内容：

1. 项目的简短描述。

2. 指向项目站点的链接（如果存在）。

3. 开发者变异环境的注意事项以及潜在的移植性问题。

4. 描述重要文件和子目录的路标。

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

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

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

8. 项目邮件列表地址。

摘录：《Unix编程艺术》第19章-开放源码：在Unix新社区中编程。