开篇之前我们做一个默认规则
除特别说明外，文章的默认https://github.com/mogujie/TeamTalk 的TeamTalk/ 为根目录。
上篇说过已然说过，README.md文件：开源软件源代码必读文件readme
很多开发人员不知道readme的重要性，但github让我们认识到这一点。
先来看看根目录下的README.md：
通过这个文件我们可以得到：
1，TeamTalk is a solution for enterprise IM
2，具体文档见doc目录下,安装之前请仔细阅读相关文档
3，交流
* qq群1:341273218(已满)
* qq群2:437335108(已满)
再来看看doc目录
由于篇幅过长，再次就不一一列出了。
README.md 文件一共说明了五点：
1，主要说明了依赖关系，以及编译server端解决依赖的工具文件
2，如何编译协议文件，以及编译协议文件的工具文件
3，如何编译服务端
4，如何部署，以及部署说明
5，试用包下载地址
阅读完之后相信你已经有了大致的编译路程的思路了，以及部署思路
RELEASE.md 是一些发布说明，可以看到发布地址以及变更，Change Log，测试账户，一直问题，以及后续Action
http接口定义.md 这个文件说明的太少，只有创建群组和更改成员
协议文件说明.md 主要说明了采用的通讯协议，但说明只是一个简略的
再来看看android的readme：
只有编译环境说明，没有别的了
win客户端和ios的没有说明文档，ios看样子是xcode的编译环境 ,mac客户端有文件，只说了版本
php也没有文件说明 pb文件没有说明，不过已经在其他地方说明了。
在进入server/src 目录下，README.md ：
1，编译环境，建议使用centos7，使用 c++ 11 新特性以及升级工具
2，第三方库：protobuf,hiredis,mariadb(mysql),log4cxx等，在编译之前执行相关工具
3，编译TeamTalk服务器：说明了编译的服务器命令以及所包含的内容，启动方式
在进入auto_setup目录下，README.md ：
1，安装说明、主要模块及各模块用途使用等，
2，一键部署，关于一键部署的说明
3，模块部署，说明了一下个模块的关系
INSTALL.md：三套部署IP配置方案，第一套是纯内网单pc,第二套是外网单pc,第三套外网多pc
在根目录下有LICENSE文件，是这个开源软件的开源协议，Apache License Version 2.0
转载注明出处，作者：一叶
来源：oschina
链接：https://my.oschina.net/u/1167885/blog/478308