Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
barry-ran committed Jun 20, 2022
1 parent d77355a commit cfc1775
Show file tree
Hide file tree
Showing 12 changed files with 8 additions and 18 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ It focuses on:

[lowlatency]: https://github.com/Genymobile/scrcpy/pull/646

![win](screenshot/win.png)
![win](screenshot/win-en.png)

![mac](screenshot/mac.jpg)
![mac](screenshot/mac-en.png)

![linux](screenshot/ubuntu.png)
![linux](screenshot/linux-en.png)

## Customized key mapping
You can write your own script to map keyboard and mouse actions to touches and clicks of the mobile phone according to your needs. [Here](docs/KeyMapDes.md) are the rules.
Expand Down Expand Up @@ -122,12 +122,7 @@ you can [build it by yourself](##Build)(just ubuntu test)


## Run
### Simple Mode
Connect to your Android device on your computer, then run the program and click `USB connect` or `WiFi connect`
### Not Simple Mode
Connect to your Android device on your computer, then run the program and click the button below to connect to the Android device.

![run](screenshot/run.png)

### Wireless connection steps (ensure that the mobile phone and PC are in the same LAN):
1. Enable USB debugging in developer options on the Android device
Expand All @@ -139,7 +134,6 @@ Connect to your Android device on your computer, then run the program and click
7. Click update device again, and another device with IP address will be found. Select this device.
8. Click start service


Note: it is not necessary to keep you Android device connected via USB after you start adbd.

Expand Down Expand Up @@ -187,6 +181,7 @@ Note: it is not necessary to keep you Android device connected via USB after you
- `Ctrl`+`v` _pastes_ the computer clipboard as a sequence of text events (but
breaks non-ASCII characters).
- Group control
- Sync device speaker sound to the computer (based on [sndcpy](https://github.com/rom1v/sndcpy), Android 10+ only)

## Shortcuts

Expand Down
13 changes: 4 additions & 9 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,11 @@ QtScrcpy可以通过USB(或通过TCP/IP)连接Android设备,并进行显示和

[低延迟]: https://github.com/Genymobile/scrcpy/pull/646

![win](screenshot/win-zh.png)

![win](screenshot/win.png)
![mac](screenshot/mac-zh.png)

![mac](screenshot/mac.jpg)

![linux](screenshot/ubuntu.png)
![linux](screenshot/linux-zh.png)

## 自定义按键映射
可以根据需要,自己编写脚本将PC键盘按键映射为手机的触摸点击,编写规则在[这里](docs/KeyMapDes_zh.md)
Expand Down Expand Up @@ -126,12 +125,7 @@ Mac OS平台,你可以直接使用我编译好的可执行程序:
目前只在ubuntu上测试过

## 运行
### 精简模式
在你的电脑上接入Android设备,然后运行程序,点击`一键USB连接`或者`一键WIFI连接`
### 非精简模式
在你的电脑上接入Android设备,然后运行程序,按顺序点击如下按钮即可连接到Android设备

![运行](screenshot/run.png)

### 无线连接步骤(保证手机和电脑在同一个局域网):
1. 安卓手机端在开发者选项中打开usb调试
Expand Down Expand Up @@ -186,6 +180,7 @@ Mac OS平台,你可以直接使用我编译好的可执行程序:
- `Ctrl` + `Shift` + `v`将计算机剪贴板复制到设备剪贴板;
- `Ctrl` +`v` 将计算机剪贴板作为一系列文本事件发送到设备(不支持非ASCII字符)。
- 群控
- 同步设备扬声器声音到电脑(基于[sndcpy](https://github.com/rom1v/sndcpy),仅支持安卓10+)

## 快捷键

Expand Down
Binary file added screenshot/linux-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/linux-zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/mac-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/mac-zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshot/mac.jpg
Binary file not shown.
Binary file removed screenshot/run.png
Binary file not shown.
Binary file removed screenshot/ubuntu.png
Binary file not shown.
Binary file added screenshot/win-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/win-zh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshot/win.png
Binary file not shown.

0 comments on commit cfc1775

Please sign in to comment.