mirror of
https://github.com/kunkundi/crossdesk.git
synced 2025-10-27 04:35:34 +08:00
[chore] update README.md
This commit is contained in:
dijunkun
33
README.md
33
README.md
@@ -1,6 +1,6 @@
|
|||||||
# CrossDesk
|
# CrossDesk
|
||||||
|
|
||||||
#### More than remote desktop
|
#### Bridging work, uniting efficiency
|
||||||
|
|
||||||
----
|
----
|
||||||
[中文](README_CN.md) / [English](README.md)
|
[中文](README_CN.md) / [English](README.md)
|
||||||
@@ -9,59 +9,52 @@
|
|||||||
|
|
||||||
# Intro
|
# Intro
|
||||||
|
|
||||||
CrossDesk is a lightweight cross-platform remote desktop. It allows multiple users to remotely control the same computer at the same time. In addition to desktop image transmission, it also supports end-to-end voice transmission, providing collaboration capabilities on the basis of remote desktop.
|
CrossDesk is a lightweight cross-platform remote desktop software.
|
||||||
|
|
||||||
CrossDesk is an experimental application of [Projectx](https://github.com/dijunkun/projectx) real-time communications library. Projectx is a lightweight cross-platform real-time communications library. It has basic capabilities such as network traversal ([RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)), video software/hardware encoding/decoding (H264), audio encoding/decoding ([Opus](https://github.com/xiph/opus)), signaling interaction, and network congestion control ([TCP over UDP](https://libnice.freedesktop.org/)).
|
CrossDesk is an experimental application of [MiniRTC](https://github.com/kunkundi/minirtc.git), a lightweight cross-platform real-time audio and video transmission library. MiniRTC provides fundamental capabilities including network traversal ([RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)), video software/hardware encoding and decoding (H264/AV1), audio encoding/decoding ([Opus](https://github.com/xiph/opus)), signaling interaction, network congestion control ([TCP over UDP](https://libnice.freedesktop.org/)), and transmission encryption ([SRTP](https://tools.ietf.org/html/rfc3711)).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Enter the remote desktop ID in the 'REMOTE ID' field on the menu bar, and click 'Connect' button to initiate the remote connection.
|
Enter the remote desktop ID in the menu bar’s “Remote ID” field and click “→” to initiate a remote connection.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
If the remote desktop is set with a connection password, the local end needs to enter the correct password to initiate the remote connection. If the password is incorrect, an "Incorrect password" alert will appear in the status bar.
|
If the remote desktop requires a connection password, you must enter the correct password on your side to successfully establish the connection.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
After connection successfully established, the status bar will display the message "ClientConnected."
|
Before connecting, you can customize configuration options in the settings, such as language and video encoding format.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## How to build
|
## How to build
|
||||||
|
|
||||||
Requirements:
|
Requirements:
|
||||||
- [xmake](https://xmake.io/#/guide/installation)
|
- [xmake](https://xmake.io/#/guide/installation)
|
||||||
- [cmake](https://cmake.org/download/)
|
- [cmake](https://cmake.org/download/)
|
||||||
- [vcpkg](https://vcpkg.io/en/getting-started)
|
|
||||||
|
|
||||||
Following packages need to be installed on Linux:
|
Following packages need to be installed on Linux:
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo apt-get install -y nvidia-cuda-toolkit libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxcb-shm0-dev libxv-dev libasound2-dev libsndio-dev libasound2-dev libpulse-dev
|
sudo apt-get install -y software-properties-common git curl unzip build-essential libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxv-dev libxtst-dev libasound2-dev libsndio-dev libxcb-shm0-dev libasound2-dev libpulse-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Commands:
|
Build:
|
||||||
```
|
```
|
||||||
git clone https://github.com/dijunkun/continuous-desk
|
git clone https://github.com/kunkundi/crossdesk.git
|
||||||
|
|
||||||
cd continuous-desk
|
cd crossdesk
|
||||||
|
|
||||||
git submodule init
|
git submodule init
|
||||||
|
|
||||||
git submodule update
|
git submodule update
|
||||||
|
|
||||||
xmake b remote_desk
|
xmake b crossdesk
|
||||||
```
|
```
|
||||||
Run:
|
Run:
|
||||||
```
|
```
|
||||||
# Windows/MacOS
|
xmake r crossdesk
|
||||||
xmake r remote_desk
|
|
||||||
|
|
||||||
# root privileges are required on Linux
|
|
||||||
./remote_desk
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## LICENSE
|
## LICENSE
|
||||||
|
|
||||||
Continuous Desk is licenced under MIT, and some third-party libraries are distributed under their licenses.
|
CrossDesk is licenced under MIT, and some third-party libraries are distributed under their licenses.
|
||||||
|
|
||||||
|
|||||||
35
README_CN.md
35
README_CN.md
@@ -1,6 +1,6 @@
|
|||||||
# Continuous Desk
|
# CrossDesk
|
||||||
|
|
||||||
#### 不止远程桌面
|
#### 跨界连接，高效如一
|
||||||
|
|
||||||
----
|
----
|
||||||
[English](README.md) / [中文](README_CN.md)
|
[English](README.md) / [中文](README_CN.md)
|
||||||
@@ -9,59 +9,52 @@
|
|||||||
|
|
||||||
## 简介
|
## 简介
|
||||||
|
|
||||||
Continuous Desk 是一个轻量级的跨平台远程桌面软件。它允许多个用户在同一时间远程操控同一台电脑。除桌面图像传输外，它还支持端到端的语音传输，在远程桌面基础上提供额外的协作能力。
|
CrossDesk 是一个轻量级的跨平台远程桌面软件。
|
||||||
|
|
||||||
Continuous Desk 是 [Projectx](https://github.com/dijunkun/projectx) 实时音视频传输库的实验性应用。Projectx 是一个轻量级的跨平台实时音视频传输库。它具有网络透传（[RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)），视频软硬编解码（H264），音频编解码（[Opus](https://github.com/xiph/opus)），信令交互，网络拥塞控制（[TCP over UDP](https://libnice.freedesktop.org/)）等基础能力。
|
CrossDesk 是 [MiniRTC](https://github.com/kunkundi/minirtc.git) 实时音视频传输库的实验性应用。MiniRTC 是一个轻量级的跨平台实时音视频传输库。它具有网络透传（[RFC5245](https://datatracker.ietf.org/doc/html/rfc5245)），视频软硬编解码（H264/AV1），音频编解码（[Opus](https://github.com/xiph/opus)），信令交互，网络拥塞控制（[TCP over UDP](https://libnice.freedesktop.org/)），传输加密（[SRTP](https://tools.ietf.org/html/rfc3711)）等基础能力。
|
||||||
|
|
||||||
|
|
||||||
## 使用
|
## 使用
|
||||||
|
|
||||||
在菜单栏“REMOTE ID”处输入远端桌面的ID，点击“Connect”即可发起远程连接。
|
在菜单栏“对端ID”处输入远端桌面的ID，点击“→”即可发起远程连接。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
如果远端桌面设置了连接密码，则本端需填写正确的连接密码才能成功发起远程连接。密码错误时，状态栏会出现“Incorrect password”告警提示。
|
如果远端桌面设置了连接密码，则本端需填写正确的连接密码才能成功发起远程连接。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
连接成功建立后，状态栏会有“ClientConnected”相关字样。
|
发起连接前，可在设置中自定义配置项，如语言、视频编码格式等。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 编译
|
## 编译
|
||||||
|
|
||||||
依赖：
|
依赖：
|
||||||
- [xmake](https://xmake.io/#/guide/installation)
|
- [xmake](https://xmake.io/#/guide/installation)
|
||||||
- [cmake](https://cmake.org/download/)
|
- [cmake](https://cmake.org/download/)
|
||||||
- [vcpkg](https://vcpkg.io/en/getting-started)
|
|
||||||
|
|
||||||
Linux环境下需安装以下包：
|
Linux环境下需安装以下包：
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo apt-get install -y nvidia-cuda-toolkit libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxcb-shm0-dev libxv-dev libasound2-dev libsndio-dev libasound2-dev libpulse-dev
|
sudo apt-get install -y software-properties-common git curl unzip build-essential libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxcb-randr0-dev libxcb-xtest0-dev libxcb-xinerama0-dev libxcb-shape0-dev libxcb-xkb-dev libxcb-xfixes0-dev libxv-dev libxtst-dev libasound2-dev libsndio-dev libxcb-shm0-dev libasound2-dev libpulse-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
编译命令
|
编译
|
||||||
```
|
```
|
||||||
git clone https://github.com/dijunkun/continuous-desk
|
git clone https://github.com/kunkundi/crossdesk.git
|
||||||
|
|
||||||
cd continuous-desk
|
cd crossdesk
|
||||||
|
|
||||||
git submodule init
|
git submodule init
|
||||||
|
|
||||||
git submodule update
|
git submodule update
|
||||||
|
|
||||||
xmake b remote_desk
|
xmake b crossdesk
|
||||||
```
|
```
|
||||||
运行
|
运行
|
||||||
```
|
```
|
||||||
# Windows/MacOS
|
xmake r crossdesk
|
||||||
xmake r remote_desk
|
|
||||||
|
|
||||||
# Linux下需使用root权限运行
|
|
||||||
./remote_desk
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 许可证
|
## 许可证
|
||||||
|
|
||||||
Continuous Desk 使用 MIT 许可证，其中使用到的第三方库根据自身许可证进行分发。
|
CrossDesk 使用 MIT 许可证，其中使用到的第三方库根据自身许可证进行分发。
|
||||||
|
|||||||
2
thirdparty/minirtc
vendored
2
thirdparty/minirtc
vendored
Submodule thirdparty/minirtc updated: 9bd0c0bbce...75bf7ca228
Reference in New Issue
Block a user