開源蘑菇街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  這個文件說明的太少，只有建立羣組和更改爲員

                協議文件說明.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

轉載註明出處，做者：一葉