如何写一个通用的README规范

我们在Github上创建项目的时候，常常会看到默认使用README文件初始化该项目，然后在新建项目的根目录下就会生成README.md文件。

有好的README文档的项目不一定是一个好的开源项目，但一个好开源项目一定有一个好的README

1. README文档的组成部分

• （一）国际化
• （二）项目工程介绍
• （三）项目的使用效果图
• （四）项目特点
• （五）项目的基本结构（架构）
• （六）集成方式
• （七）使用方法
• （八）混淆
• （九）关于作者/组织及交流方式等信息。
• （十）贡献者/贡献组织
• （十一）鸣谢
• （十二）版权信息

一）国际化

github是面向全球的一个开源网站，所以不要局限于中文文档，建议写一个英文的README，让来自全球的人都能更方便的了解你的项目。推荐写法，在REAMDE开头写上国际化引用地址

（二）项目工程介绍

项目介绍是必不可少的，它能让别人快速了解项目。项目介绍主要包括：

• 项目名称、logo（没有logo就不写）
• 这个开源项目是做什么的？
• 这个项目是什么语言编写的？
• 这个项目目前被多少人用到了，有多少好评等？
• 项目维护、依赖更新状态（如果有的话，这也可以用）等
• 项目可用版本及其他版本，以及每个版本的更新信息记录
• Demo 或官网地址（如果有）

上述案例里面那些图标，请参考这个网站 Shields.io，打开之后想用哪个直接复制就可以了，同时它也支持自定义样式。

（三） 项目的使用效果