Skip to content

Commit 08d5082

Browse files
author
str2num
committed
modify README
1 parent 5298c9c commit 08d5082

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ ICE的主要工作就是在Agent L和Agent R之间,找到一条或者多条路
4545
+ [RFC5389] STUN协议: https://tools.ietf.org/html/rfc5389
4646
+ [RFC5766] TURN协议: https://tools.ietf.org/html/rfc5766
4747

48+
### 要求
49+
+ 目前仅适用于Linux平台
50+
+ gcc版本建议使用gcc-4.8.4及其更高版本, 该库使用了大量的c++11语法,gcc版本过低将无法编译通过
51+
+ 依赖libev-4.22或者以上版本
52+
+ openssl版本不低于1.0.0
53+
4854
### 编译安装
4955
#### 编译工具
5056
本库的编译采用了buildmake工具,可以帮助你生成Makefile文件,buildmake是一个使用非常简单的编译环境构建工具,推荐使用。
@@ -66,7 +72,9 @@ vim BUILDMAKE
6672
BUILDMAKE_BIN_PATH('~/opensource/buildmake/buildmake') # 该选项路径务必修改为你自己机器上的buildmake工具执行路径
6773

6874
# 执行buildmake命令
69-
buildmake -UB # libice库依赖另外一个git项目librtcbase,-U选项可以帮助你获取librtcbase库 -B表示执行编译
75+
# libice库依赖另外一个git项目librtcbase,-U选项可以帮助你获取librtcbase库 -B表示执行编译
76+
# 需要注意的是:librtcbase依赖libev, librtcbase在编译过程遇到问题,请参考https://github.com/str2num/librtcbase
77+
buildmake -UB
7078

7179
# 执行make, make成功之后会在项目根目录生成一个output,output目录包含libice的库文件
7280
make
@@ -83,7 +91,7 @@ make
8391
+ 在项目的example目录,有一个示例demo,使用libice库实现了一个简单版的1v1消息聊天软件。
8492
+ 后续会提供一个1v1实时音视频通话的demo。
8593

86-
### 使用文档
87-
该库的使用文档,正在积极建设当中,敬请期待, 谢谢!
94+
### 帮助文档
95+
该库的帮助文档,正在积极建设当中,敬请期待, 谢谢!
8896

8997

0 commit comments

Comments
 (0)