一个合格的ReadMe文档应该包含的信息

1. 整个项目的介绍[说明创建项目意图或是解决问题等]。

2. 指出开发者编译整个项目需要的系统环境参数.并指出项目可能潜在的移植性问题。

3. 当前项目中重要的文件和子目录的结构信息。[必须]

4. 项目更多资源支持站点或是版本更新包获取所在的URL地址。

5. 编译或安装步骤说明.或是指明这些信息所在的文件名。

6. 关于本项目的版本更新或当前项目进展等信息。

7. FAQ：以纯文本格式关于项目常见问题的解答。