文档章节

开源蘑菇街TeamTalk开篇之readme&doc

一一叶
 一一叶
发布于 2015/07/14 12:07
字数 712
阅读 798
收藏 7

开篇之前我们做一个默认规则

         除特别说明外,文章的默认https://github.com/mogujie/TeamTalk TeamTalk/ 为根目录。 

         上篇说过已然说过,README.md文件:开源软件源代码必读文件readme

很多开发人员不知道readme的重要性,但github让我们认识到这一点。

         先来看看根目录下的README.md: 

         

 

通过这个文件我们可以得到:

       1TeamTalk is a solution for enterprise IM

         2,具体文档见doc目录下,安装之前请仔细阅读相关文档

         3,交流

                            * qq1:341273218(已满)

                            * qq2:437335108(已满)

 

再来看看doc目录

                                    

由于篇幅过长,再次就不一一列出了。

                README.md 文件一共说明了五点:

                            1,主要说明了依赖关系,以及编译server端解决依赖的工具文件

                            2,如何编译协议文件,以及编译协议文件的工具文件

                            3,如何编译服务端

                            4,如何部署,以及部署说明

                            5,试用包下载地址

                   阅读完之后相信你已经有了大致的编译路程的思路了,以及部署思路

     RELEASE.md 是一些发布说明,可以看到发布地址以及变更,Change Log,测试账户,一直问题,以及后续Action

                   http接口定义.md  这个文件说明的太少,只有创建群组和更改成员

                协议文件说明.md  主要说明了采用的通讯协议,但说明只是一个简略的

再来看看androidreadme

                                              

               只有编译环境说明,没有别的了

         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

转载注明出处,作者:一叶

© 著作权归作者所有

一一叶
粉丝 28
博文 21
码字总数 8193
作品 0
浦东
高级程序员
私信 提问
加载中

评论(1)

一一叶
一一叶
8000 8080 8100 8200 8700 10600 8400 防火墙端口 功能齐全
开源IM工程“蘑菇街TeamTalk”的现状:一场有始无终的开源秀

1、前言 随着云IM的发展,已吸引越来越多有IM需求的APP接入。但考虑到云IM无论从商业模式还是运营模式上,还需经过多年的沉淀,才可能真正实现客户与服务商的运营和服务良性循环的双赢局面。...

JackJiang-
2016/07/28
2.4K
4
TeamTalk 的公开声明

TeamTalk关于“TT牵涉POPO版权,被 Github 下架”一事的公开声明 TeamTalk系蘑菇街技术团队几位工程师利用业余时间开发的一套IM软件,一直被蘑菇街用于公司内部沟通使用。今年9月26日,我们决...

张远浩
2014/11/05
18.2K
97
TeamTalk 牵涉网易泡泡版权,被 Github 下架

TeamTalk 是蘑菇街发布的一款开源软件,该项目托管在 Github 平台上。不过你可能注意到了目前该账号下所有跟 TeamTalk 相关的软件仓库都已经被 Github 禁用了,目前访问这些项目会看到提示:...

oschina
2014/11/05
20.6K
71
用libevent改造teamtalk底层网络框架

(没想到文章被oschina置顶推荐了,赶紧来加个广告,欢迎加入我们的teamtalk qq群437335108,此群是原蘑菇街teamtalk官方群管理者蓝狐离开蘑菇街后新开辟的分支群。) teamtalk是蘑菇街推出的...

笨笨_蛋蛋
2015/09/02
0
14
蘑菇街TeamTalk

蘑菇街TeamTalk的数据库脚本没在源码找到啊?是没有提供吗?

niitwj
2015/02/07
1K
1

没有更多内容

加载失败,请刷新页面

加载更多

基础工具类

package com.atguigu.util;import java.sql.Connection;import java.sql.SQLException;import java.util.Properties;import javax.sql.DataSource;import com.alibaba.druid......

architect刘源源
今天
43
0
P30 Pro劲敌!DxO官宣新机:排行榜又要变

5月26日晚间,DxOMark官方推特预告,将在5月27日公布一款新机型的DxOMark评分,猜猜是哪款? 网友猜想的机型有:红米K20、谷歌Pixel 3a、索尼Xperia 1、诺基亚9 PureView等。 DxOMark即将公布...

linux-tao
昨天
15
0
Ubuntu18.04.2窗口过小不能自适应(二次转载)

解决Ubuntu在虚拟机窗口不能自适应 2018年09月06日 16:20:08 起不了名儿 阅读数 855 此博文转载:https://blog.csdn.net/nuddlle/article/details/77994080(原地址) 试了很多办法这个好用 ...

tahiti_aa
昨天
2
0
死磕 java同步系列之CountDownLatch源码解析

问题 (1)CountDownLatch是什么? (2)CountDownLatch具有哪些特性? (3)CountDownLatch通常运用在什么场景中? (4)CountDownLatch的初始次数是否可以调整? 简介 CountDownLatch,可以...

彤哥读源码
昨天
6
0
Nginx提供下载apk服务

有时候我们可能需要提供文件或者其他apk下载链接,通过 nginx 配置可以很简单地实现。 server {    listen 80;    server_name download.xxx.com;    root app;    locati...

Jack088
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部