开源蘑菇街TeamTalk开篇之readme&doc
开篇之前我们做一个默认规则 除特别说明外,文章的默认 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