Skip to content

Commit f4fbf6d

Browse files
committed
update:readme and docment
1 parent d75d116 commit f4fbf6d

File tree

4 files changed

+37
-27
lines changed

4 files changed

+37
-27
lines changed

README.en.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[中文](README.md) || [English](README.en.md)
22
# XEngine_MQService
33
This repository has a development and master branch. If you want to use it, please use the master branch
4+
As long as the repository is not in suspended state, we will maintain and develop it all the time, please use it with confidence
45

56
#### Description
67
c c++消息服务 消息中间件
@@ -32,32 +33,34 @@ this software support following features
3233

3334
## install
3435

35-
#### Requirements
36-
support system above windows 7sp1 and linux(ubuntu20.04,centos8)
37-
XEngine need V7.23 or above
36+
#### XEngine Evn
37+
you must install XEngine,need V7.38 or above,install XEngine can be refer to xengine Readme docment
38+
GITEE:https://gitee.com/xyry/libxengine
39+
GITHUB:https://github.com/libxengine/xengine
40+
41+
##### fast to deployment
42+
git clone https://gitee.com/xyry/libxengine.git or git clone https://github.com/libxengine/xengine.git
43+
window Exection XEngine_WINEnv.bat
44+
Linux Exection:sudo ./XEngine_LINEnv.sh -i 3
45+
Macos Exection:./XEngine_LINEnv.sh -i 3
3846

3947
#### Windows
40-
use vs open and complie
41-
You need to configure the environment in the following way, otherwise you may need to set the library directory in the project yourself
48+
use vs open and complie,support windows 7sp1 and above
49+
Just Run it.
4250

4351
#### Linux
4452
Linux use Makefile to complie
45-
supproted ubuntu x64 or centos x64
53+
supproted ubuntu x64 or centos x64
54+
55+
#### MacOS
56+
Linux use Makefile to complie,terminal exection,Requires mac 12 and above
4657

47-
##### XEngine Install
48-
you can install xengine env to your system by shell
49-
like this:sudo XEngine_RunEnv.sh -i 3
5058
##### complie
5159
execute command in XEngine_Source path
5260
make complie
5361
make FLAGS=InstallAll install
5462
make FLAGS=CleanAll clear
5563

56-
#### XEngine Env
57-
install XEngine can be refer to xengine Readme docment
58-
GITEE:https://gitee.com/xyry/libxengine
59-
GITHUB:https://github.com/libxengine/xengine
60-
6164
#### use
6265

6366
1. Switch to the MASTER branch

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[中文](README.md) || [English](README.en.md)
22
# XEngine_MQService
33
本仓库有开发和主分支,如果要使用,请使用master分支下的代码
4+
只要仓库不是在暂停状态,那么就会有人一直维护和开发,请放心使用
45

56
## 介绍
67
c c++消息服务 消息中间件
@@ -31,29 +32,36 @@ c c++Message Service
3132

3233
## 安装教程
3334

34-
#### 版本需求
35-
支持WINDOWS 7SP1和LINUX(UBUNT20.04,CENTOS8)以上系统
36-
XEngine版本需要V7.30或者以上版本
35+
#### XEngine环境
36+
必须安装XEngine,版本需要V7.38或者以上版本,安装XEngine可以参考其Readme文档
37+
GITEE:https://gitee.com/xyry/libxengine
38+
GITHUB:https://github.com/libxengine/xengine
39+
40+
##### 快速部署
41+
git clone https://gitee.com/xyry/libxengine.git 或者 git clone https://github.com/libxengine/xengine.git
42+
window执行XEngine_WINEnv.bat 脚本.
43+
Linux执行:sudo ./XEngine_LINEnv.sh -i 3
44+
macos执行:./XEngine_LINEnv.sh -i 3
3745

3846
#### Windows
39-
使用VS打开并且编译
40-
你需要按照下面的方式配置环境,不然你可能需要自己在项目中设置库目录
47+
使用VS打开并且编译,支持WINDOWS 7SP1以上系统
48+
直接运行即可
4149

4250
#### Linux
4351
Linux使用Makefile编译
4452
UBUNTU20.04 x64或者CENTOS8 x64均可
53+
在控制台运行
54+
55+
#### MacOS
56+
使用makefile编译,控制台运行,需要mac 12以及以上版本
57+
在控制台运行
4558

4659
##### 编译命令
47-
在XEngine_Source目录下执行命令
60+
在XEngine_Source目录下执行命令
4861
make 编译
4962
make FLAGS=InstallAll 安装库程序
5063
make FLAGS=CleanAll 清理编译
5164

52-
#### XEngine环境
53-
安装XEngine可以参考其Readme文档
54-
GITEE:https://gitee.com/xyry/libxengine
55-
GITHUB:https://github.com/libxengine/xengine
56-
5765
#### 使用说明
5866

5967
1. 切换到MASTER分支
@@ -87,11 +95,10 @@ GITHUB:https://github.com/libxengine/xengine
8795
如果你觉得这个软件对你有帮助,请你给我们一个START吧
8896

8997
## 开发计划
90-
自动移除超时客户端
98+
DDS消息订阅与发布
9199
扩展获取消息的内容
92100
消息属性生效
93101
删除包协议
94-
Session支持
95102

96103
## 提交问题
97104

XEngine_Docment/Docment_en.docx

391 Bytes
Binary file not shown.

XEngine_Docment/Docment_zh.docx

927 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)