mirror of
https://github.com/kunkundi/crossdesk.git
synced 2025-10-26 12:15:34 +08:00
[chore] update README
This commit is contained in:
46
README.md
46
README.md
@@ -27,7 +27,7 @@ CrossDesk 是 [MiniRTC](https://github.com/kunkundi/minirtc.git) 实时音视频
|
|||||||
发起连接前,可在设置中自定义配置项,如语言、视频编码格式等。
|
发起连接前,可在设置中自定义配置项,如语言、视频编码格式等。
|
||||||

|

|
||||||
|
|
||||||
## 编译
|
## 如何编译
|
||||||
|
|
||||||
依赖:
|
依赖:
|
||||||
- [xmake](https://xmake.io/#/guide/installation)
|
- [xmake](https://xmake.io/#/guide/installation)
|
||||||
@@ -51,7 +51,51 @@ git submodule update
|
|||||||
|
|
||||||
xmake b crossdesk
|
xmake b crossdesk
|
||||||
```
|
```
|
||||||
|
#### 无 CUDA 环境下的开发支持
|
||||||
|
|
||||||
|
对于未安装 **CUDA 环境** 的Linux开发者,这里提供了预配置的 [Ubuntu 22.04 Docker 镜像](https://hub.docker.com/r/crossdesk/ubuntu22.04)。
|
||||||
|
该镜像内置必要的构建依赖,可在容器中开箱即用,无需额外配置即可直接编译项目。
|
||||||
|
|
||||||
|
进入容器,下载工程后执行:
|
||||||
|
```
|
||||||
|
export CUDA_PATH=/usr/local/cuda
|
||||||
|
export XMAKE_GLOBALDIR=/data
|
||||||
|
|
||||||
|
xmake b --root crossdesk
|
||||||
|
```
|
||||||
|
|
||||||
运行
|
运行
|
||||||
```
|
```
|
||||||
xmake r crossdesk
|
xmake r crossdesk
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 关于 Xmake
|
||||||
|
|
||||||
|
#### 安装 Xmake
|
||||||
|
使用 curl:
|
||||||
|
```
|
||||||
|
curl -fsSL https://xmake.io/shget.text | bash
|
||||||
|
```
|
||||||
|
使用 wget:
|
||||||
|
```
|
||||||
|
wget https://xmake.io/shget.text -O - | bash
|
||||||
|
```
|
||||||
|
使用 powershell:
|
||||||
|
```
|
||||||
|
irm https://xmake.io/psget.text | iex
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 编译选项
|
||||||
|
```
|
||||||
|
# 切换编译模式
|
||||||
|
xmake f -m debug/release
|
||||||
|
|
||||||
|
# 可选编译参数
|
||||||
|
-r :重新构建目标
|
||||||
|
-v :显示详细的构建日志
|
||||||
|
-y :自动确认提示
|
||||||
|
|
||||||
|
# 示例
|
||||||
|
xmake b -vy crossdesk
|
||||||
|
```
|
||||||
|
更多使用方法可参考 [Xmake官方文档](https://xmake.io/guide/quick-start.html) 。
|
||||||
47
README_EN.md
47
README_EN.md
@@ -51,7 +51,54 @@ git submodule update
|
|||||||
|
|
||||||
xmake b crossdesk
|
xmake b crossdesk
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Development Without CUDA Environment
|
||||||
|
|
||||||
|
For developers who do not have a **CUDA environment** installed, a preconfigured [Ubuntu 22.04 Docker image](https://hub.docker.com/r/crossdesk/ubuntu22.04) is provided.
|
||||||
|
This image comes with all required build dependencies and allows you to build the project directly inside the container without any additional setup.
|
||||||
|
|
||||||
|
After entering the container, download the project and run:
|
||||||
|
```
|
||||||
|
export CUDA_PATH=/usr/local/cuda
|
||||||
|
export XMAKE_GLOBALDIR=/data
|
||||||
|
|
||||||
|
xmake b --root crossdesk
|
||||||
|
```
|
||||||
|
|
||||||
Run:
|
Run:
|
||||||
```
|
```
|
||||||
xmake r crossdesk
|
xmake r crossdesk
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## About Xmake
|
||||||
|
#### Installing Xmake
|
||||||
|
|
||||||
|
You can install Xmake using one of the following methods:
|
||||||
|
|
||||||
|
Using curl:
|
||||||
|
```
|
||||||
|
curl -fsSL https://xmake.io/shget.text | bash
|
||||||
|
```
|
||||||
|
Using wget:
|
||||||
|
```
|
||||||
|
wget https://xmake.io/shget.text -O - | bash
|
||||||
|
```
|
||||||
|
Using powershell:
|
||||||
|
```
|
||||||
|
irm https://xmake.io/psget.text | iex
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Build Options
|
||||||
|
```
|
||||||
|
# Switch build mode
|
||||||
|
xmake f -m debug/release
|
||||||
|
|
||||||
|
# Optional build parameters
|
||||||
|
-r : Rebuild the target
|
||||||
|
-v : Show detailed build logs
|
||||||
|
-y : Automatically confirm prompts
|
||||||
|
|
||||||
|
# Example
|
||||||
|
xmake b -vy crossdesk
|
||||||
|
```
|
||||||
|
For more information, please refer to the [official Xmake documentation](https://xmake.io/guide/quick-start.html) .
|
||||||
2
thirdparty/minirtc
vendored
2
thirdparty/minirtc
vendored
Submodule thirdparty/minirtc updated: 5c8f4567b5...3de3620f9e
Reference in New Issue
Block a user