Skip to content

Commit 69acf54

Browse files
committed
update: readme
1 parent 71a2002 commit 69acf54

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

readme.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,40 @@ DeviceShare 是一款跨平台的多主机输入设备共享工具,支持 Wind
2020
9. **易用性**:支持一键启动,无需复杂配置。
2121
10. **开源免费**:支持开源免费使用。
2222

23-
**演示环境**
24-
![1719817611466.png](https://img.qylh.xyz/blog/1719817611466.png)
2523

26-
**双机演示**
24+
## 项目演示
2725

28-
https://github.com/qy-liuhuo/deviceShare/assets/60374114/6e126292-22e0-4d91-bab9-272470689ecd
2926

27+
项目在Windows10、Debian12、Ubuntu20.4、MacOS、openKylin等多个平台进行运行演示,服务端主机连接usb键鼠,所有主机以无线局域网的形式连接,测试环境如下图所示:
3028

31-
**三机演示**
29+
![1723257064070.png](https://img.qylh.xyz/blog/1723257064070.png)
3230

33-
https://github.com/qy-liuhuo/deviceShare/assets/60374114/1b911b8a-976f-4128-9518-9c64c73a7a39
31+
<video src="https://img.qylh.xyz/demo.mp4"></video>
3432

3533

34+
[//]: # (**双机演示**)
3635

37-
## 使用说明
36+
[//]: # ()
37+
[//]: # (https://github.com/qy-liuhuo/deviceShare/assets/60374114/6e126292-22e0-4d91-bab9-272470689ecd)
38+
39+
[//]: # ()
40+
[//]: # ()
41+
[//]: # (**演示**)
42+
43+
[//]: # ()
44+
[//]: # (https://github.com/qy-liuhuo/deviceShare/assets/60374114/1b911b8a-976f-4128-9518-9c64c73a7a39)
45+
46+
47+
48+
## 说明
3849
针对x86架构的Windows、OpenKylin操作系统,我们打包构建了可执行程序,可在Release界面下载合适的版本。
3950

51+
1. 若在Linux下运行,采用脚本`run.sh`启动程序,将`run.sh`复制到dist目录下,执行`sudo chmod 777 run.sh`赋予执行权限,执行`bash run.sh`启动程序
52+
2. 若为windows环境,直接运行exe文件即可
53+
54+
55+
### Build说明
56+
4057
若构建的版本无法支持目标机器,可选择源码运行或自行打包。该方案需具备Python3 环境,具体步骤如下:
4158
1. 获取项目代码
4259
2. 使用`pip install -r requirements.txt`命令安装依赖
@@ -45,9 +62,16 @@ https://github.com/qy-liuhuo/deviceShare/assets/60374114/1b911b8a-976f-4128-9518
4562
5. 使用`pyinstaller`打包目标程序: `pyinstaller deviceShare.spec`
4663
6. 运行`dist`目录下生成的可执行文件
4764
7.`resources`目录复制到dist目录下
48-
8. 若在Linux下运行,采用脚本`run.sh`启动程序,将`run.sh`复制到dist目录下,执行`sudo chmod 777 run.sh`赋予执行权限,执行`bash run.sh`启动程序,windows下无需执行此步骤,直接运行exe文件即可
4965

50-
6. 注意Kylin操作系统在安装python的evdev依赖时可能出现错误,请选择安装预编译版本evdev-binary,参考 https://python-evdev.readthedocs.io/en/latest/install.html
66+
**注意**Kylin操作系统在安装python的evdev依赖时可能出现错误,请选择安装预编译版本evdev-binary,参考 https://python-evdev.readthedocs.io/en/latest/install.html
67+
68+
## 使用说明
69+
1. 将主控机和被控机连接到同一局域网环境下,保证两台机器能够互相ping通,分别按照要求启动软件,选择各自的角色(注意局域网防火墙配置)
70+
2. 右键单击主控机右下角的桌面托盘,点击设置,可以看到被控机屏幕位置示意图,可拖动修改位置,修改完成后点击确定。
71+
3. 在主控机上将光标移动到靠近被控机方向的边缘即可进入被控机。
72+
4. 在被控机上将光标移动到靠近主控机方向的边缘即可回到主控机。
73+
5. 在主控机和被控机上分别右键单机托盘图标选择退出即可关闭软件
74+
5175

5276
## 控制原理
5377

0 commit comments

Comments
 (0)