diff --git a/README.md b/README.md index b6a35374fa4ed89bd9a44ff40432da8b33b2c10d..0fc6c4f62ef9e8dcaaf85cc612bd07b8d58e8c83 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ -# 介绍 -华为VMI引擎云手机开源项目 +# VMI +## 介绍 +华为VMI引擎云手机开源项目,用于编译视频流引擎。 -# 软件架构 +## 软件架构 请参考 [目录结构.md](/doc/目录结构.md) 文档 -# 使用说明 -## 工程编译 -### 编译机推荐配置 +## 使用说明 +### 工程编译 +#### 编译机推荐配置 系统版本:Ubuntu 22.04.3 LTS 系统架构:x86_64 -### 网络要求 +#### 网络要求 保证服务器正常联网,以确保可以正常gradle编译和下载开源软件。 -### 安装依赖库 +#### 安装依赖库 ``` sudo apt install -y git sudo apt install -y libtool automake tclsh make openjdk-11-jdk git-core gnupg @@ -30,10 +31,10 @@ sudo apt install -y m4 bc python3 python3-mako gettext sudo apt install -y expect ``` -### 执行脚本 +#### 执行脚本 如果想了解各脚本的具体实现细节,请参考 [编译脚本介绍.md](/doc/编译脚本介绍.md) 文档 -#### 安装编译环境 +##### 安装编译环境 ``` ./scripts/auto_install_tools.sh ${安装目录} source ~/.bashrc @@ -43,24 +44,26 @@ source ~/.bashrc 此脚本执行成功后,之后不需要再重复执行。 -#### 编译客户端 +##### 编译客户端 ``` ./build_video.sh video_client ``` 命令执行成功后,将在output目录生成CloudPhoneApk.tar.gz和已解压好的CloudPhone.apk -#### 编译服务端 +##### 编译服务端 ``` ./build_video.sh video_server ``` 命令执行成功后,将在output目录生成DemoVideoEngine.tar.gz -## 使用视频流 +### 使用视频流 请确认已完成 [编译客户端](#buildclient) 和 [编译服务端](#buildserver) 章节,并获取到CloudPhone.apk、CloudPhoneApk.tar.gz和DemoVideoEngine.tar.gz文件。 之后,请参考 [鲲鹏Boostkit ARM原生使能套件特性指南文档](https://www.hikunpeng.com/document/detail/zh/kunpengcps/cpturbokit/videostreamengine/kunpengcpsvideo_20_0002.html),使用云手机。 -# 参与贡献 +## 参与贡献 +``` 如果您想为本仓库贡献代码,请向本仓库任意maintainer发送邮件 -如果您找到产品中的任何Bug,欢迎您提出ISSUE \ No newline at end of file +如果您找到产品中的任何Bug,欢迎您提出ISSUE +``` \ No newline at end of file