Open source Mushroom Street TEAMtalk opening Readme&doc

We'll make a default rule before we go.

except for special instructions, the default https://github.com/mogujie/TeamTalk of the article teamtalk/ is the root directory.

as I said in the previous article, readme.md file: Source code required to read open source software Readme

Many developers don't know the importance of the Readme, but GitHub lets us realize that.

Let 's take a look at the root directory. README.MD:

Through this file we can get:

1, TEAMtalk isa solution for enterprise IM

2 , see the specific documentation Doc directory under , Please read the relevant documentation carefully before installing

3 , Exchange

* QQ Group 1:341273218 ( full )

* QQ Group 2:437335108 ( full )

Look at the doc directory again .

As the space is too long, it is not listed again.

A total of five points are stated in the Readme.md file:

1 , mainly describes the dependencies, and compiles Server -end resolution of dependent tool files

2 , how to compile the protocol file, and the tool file to compile the protocol file

3 , how to compile the service side

4 , how to deploy, and deployment instructions

5 , trial package

After reading, I believe you have a rough idea of how to compile your journey, and how to deploy it.

release.md is a release note that shows the release address and changes, changeLog, test account, ongoing issue, and subsequent Action

The HTTP interface definition . MD This file illustrates too little, only creating groups and changing members

Description of the protocol file . MD mainly describes the use of the communication protocol, but the explanation is only a brief

Look at it again . Android of the Readme :

Only compile the environment instructions, nothing else.

No documentation for the win client and iOS ,iOS looks like Xcode The compilation environment , Mac client has files, only said version

PHP There are no documents to explain PB The document is not stated, but it has been explained elsewhere.

under enter the server/src directory,readme.md :

1 , compiling the environment, it is recommended to use Centos7 , using C + + new features and upgrade tools

2 , third-party libraries: protobuf,hiredis,mariadb (MySQL), Log4cxx and so on, execute the relevant tools before compiling

3 , compiling TEAMtalk server: Describes the compiled server commands and what they contain, how they are started

under enter the auto_setup directory,readme.md :

1 , installation instructions, main modules and the use of various modules,

2 , one-click Deployment, instructions for one-click Deployment

3 , module deployment, explains the relationship between the modules

install.md: Three sets of deployment IP configuration scheme, the first one is pure intranet single pc, the second set is the external network single pc, the third set of external network multi- pc

in the root directory there are LICENSE file, the Open source protocol for this open source software, Apache License Version 2.0

Reproduced in the source, one leaf

Open source Mushroom Street TEAMtalk opening Readme&doc