[chore] update README

This commit is contained in:
dijunkun
2025-10-20 01:36:42 +08:00
parent b9e8192eee
commit ab13fa582d
3 changed files with 41 additions and 30 deletions

3
.gitattributes vendored Normal file
View File

@@ -0,0 +1,3 @@
*.h linguist-language=C++
*.cpp linguist-language=C++
*.lua linguist-language=Xmake

View File

@@ -1,8 +1,5 @@
# CrossDesk # CrossDesk
#### 跨界连接,高效如一
----
[English](README_EN.md) / [中文](README.md) [English](README_EN.md) / [中文](README.md)
![sup_example](https://github.com/user-attachments/assets/eeb64fbe-1f07-4626-be1c-b77396beb905) ![sup_example](https://github.com/user-attachments/assets/eeb64fbe-1f07-4626-be1c-b77396beb905)
@@ -72,7 +69,7 @@ xmake r crossdesk
#### 注意 #### 注意
运行时如果客户端状态栏显示 **未连接服务器**,请先在 [CrossDesk 官方网站](https://www.crossdesk.cn/) 安装客户端,以便在环境中安装所需的证书文件。 运行时如果客户端状态栏显示 **未连接服务器**,请先在 [CrossDesk 官方网站](https://www.crossdesk.cn/) 安装客户端,以便在环境中安装所需的证书文件。
<img width="129" height="60" alt="image" src="https://github.com/user-attachments/assets/1812f7d6-516b-4b4f-8a3d-98bee505cc5a" /> <img width="256" height="120" alt="image" src="https://github.com/user-attachments/assets/1812f7d6-516b-4b4f-8a3d-98bee505cc5a" />
## 关于 Xmake ## 关于 Xmake
@@ -239,25 +236,32 @@ chmod +x generate_certs.sh
``` ```
输出如下: 输出如下:
``` ```
生成根证书私钥... Generating root private key...
生成自签根证书... Generating self-signed root certificate...
生成服务器私钥... Generating server private key...
生成服务器证书签名请求(CSR... Generating server CSR...
用根证书签发服务器证书... Signing server certificate with root certificate...
Certificate request self-signature ok Certificate request self-signature ok
subject=C = CN, ST = Zhejiang, L = Hangzhou, O = CrossDesk, OU = CrossDesk, CN = CrossDesk subject=C = CN, ST = Zhejiang, L = Hangzhou, O = CrossDesk, OU = CrossDesk, CN = xxx.xxx.xxx.xxx
清理中间文件... cleaning up intermediate files...
生成完成,部署时需要: Generation complete. Deployment files::
根证书: crossdesk.cn_root.crt Client root certificate:: crossdesk.cn_root.crt
服务器私钥: crossdesk.cn.key Server private key: crossdesk.cn.key
服务器证书: crossdesk.cn_bundle.crt Server certificate: crossdesk.cn_bundle.crt
``` ```
#### 服务端 #### 服务端
**crossdesk.cn.key****crossdesk.cn_bundle.crt** 放置到 **/path/to/your/certs** 目录下。 **crossdesk.cn.key****crossdesk.cn_bundle.crt** 放置到 **/path/to/your/certs** 目录下。
#### 客户端 #### 客户端
1. 点击右上角设置进入设置页面。 1. 点击右上角设置进入设置页面。<br>
2. 点击点击**自托管服务器配置**。 <img width="600" height="210" alt="image" src="https://github.com/user-attachments/assets/6431131d-b32a-4726-8783-6788f47baa3b" /><br><br>
3. 在**证书文件路径**选择框中找到 **crossdesk.cn_root.crt** 的存放路径,选中 **crossdesk.cn_root.crt**
4. 勾选使用**自托管服务器配置**。 3. 点击点击**自托管服务器配置**。<br><br>
<img width="600" height="160" alt="image" src="https://github.com/user-attachments/assets/24c761a3-1985-4d7e-84be-787383c2afb8" /><br><br>
5. 在**证书文件路径**选择框中找到 **crossdesk.cn_root.crt** 的存放路径,选中 **crossdesk.cn_root.crt**,点击确认。<br><br>
<img width="600" height="220" alt="image" src="https://github.com/user-attachments/assets/4af7cd3a-c72e-44fb-b032-30e050019c2a" /><br><br>
7. 勾选使用**自托管服务器配置**,点击确认配置生效。<br><br>
<img width="600" height="160" alt="image" src="https://github.com/user-attachments/assets/1e455dc3-4087-4f37-a544-1ff9f8789383" /><br><br>

View File

@@ -1,8 +1,5 @@
# CrossDesk # CrossDesk
#### Bridging work, uniting efficiency
----
[中文](README.md) / [English](README_EN.md) [中文](README.md) / [English](README_EN.md)
![sup_example](https://github.com/user-attachments/assets/3f17d8f3-7c4a-4b63-bae4-903363628687) ![sup_example](https://github.com/user-attachments/assets/3f17d8f3-7c4a-4b63-bae4-903363628687)
@@ -17,15 +14,15 @@ CrossDesk is an experimental application of [MiniRTC](https://github.com/kunkund
Enter the remote desktop ID in the menu bars “Remote ID” field and click “→” to initiate a remote connection. Enter the remote desktop ID in the menu bars “Remote ID” field and click “→” to initiate a remote connection.
![usage1](https://github.com/user-attachments/assets/bf39f8fa-de77-41a1-8db3-73d6cab9da6a) ![usage1](https://github.com/user-attachments/assets/3a4bb59f-c84c-44d2-9a20-11790aac510e)
If the remote desktop requires a connection password, you must enter the correct password on your side to successfully establish the connection. If the remote desktop requires a connection password, you must enter the correct password on your side to successfully establish the connection.
![password](https://github.com/user-attachments/assets/f6556966-a84f-4301-a79b-2726b389ed71) ![password](https://github.com/user-attachments/assets/1beadcce-640d-4f5c-8e77-51917b5294d5)
Before connecting, you can customize configuration options in the settings, such as language and video encoding format. Before connecting, you can customize configuration options in the settings, such as language and video encoding format.
![settings](https://github.com/user-attachments/assets/12f7e9c3-a472-40c1-8fb9-ae7d1ae3865c) ![settings](https://github.com/user-attachments/assets/8bc5468d-7bbb-4e30-95bd-da1f352ac08c)
## How to build ## How to build
@@ -73,7 +70,7 @@ xmake r crossdesk
#### Notice #### Notice
If the client status bar shows **Disconnected** during runtime, please first install the client from the [CrossDesk official website](https://www.crossdesk.cn/) to ensure the required certificate files are available in the environment. If the client status bar shows **Disconnected** during runtime, please first install the client from the [CrossDesk official website](https://www.crossdesk.cn/) to ensure the required certificate files are available in the environment.
<img width="108" height="57" alt="image" src="https://github.com/user-attachments/assets/26e8b9f3-b326-410e-9466-dd073eaf675a" /> <img width="256" height="120" alt="image" src="https://github.com/user-attachments/assets/1812f7d6-516b-4b4f-8a3d-98bee505cc5a" />
## About Xmake ## About Xmake
#### Installing Xmake #### Installing Xmake
@@ -261,7 +258,14 @@ Generation complete. Deployment files::
Place **crossdesk.cn.key** and **crossdesk.cn_bundle.crt** into the **/path/to/your/certs** directory. Place **crossdesk.cn.key** and **crossdesk.cn_bundle.crt** into the **/path/to/your/certs** directory.
#### Client Side #### Client Side
1. Click the settings icon in the top-right corner to enter the settings page. 1. Click the settings icon in the top-right corner to enter the settings page.<br>
2. Click **Self-Hosted Server Configuration**. <img width="600" height="210" alt="image" src="https://github.com/user-attachments/assets/6431131d-b32a-4726-8783-6788f47baa3b" /><br><br>
3. In the **Certificate File Path** selection, locate and select the **crossdesk.cn_root.crt** file.
4. Check the option to use **Self-Hosted Server Configuration**. 2. Click **Self-Hosted Server Configuration**.<br><br>
<img width="600" height="160" alt="image" src="https://github.com/user-attachments/assets/24c761a3-1985-4d7e-84be-787383c2afb8" /><br><br>
3. In the **Certificate File Path** selection, locate and select the **crossdesk.cn_root.crt** file.<br><br>
<img width="600" height="220" alt="image" src="https://github.com/user-attachments/assets/4af7cd3a-c72e-44fb-b032-30e050019c2a" /><br><br>
4. Check the option to use **Self-Hosted Server Configuration**.<br><br>
<img width="600" height="160" alt="image" src="https://github.com/user-attachments/assets/1e455dc3-4087-4f37-a544-1ff9f8789383" /><br><br>