Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rankun committed Jan 16, 2020
1 parent 7521639 commit 610175c
Show file tree
Hide file tree
Showing 5 changed files with 364 additions and 7 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ A single application can support up to 16 Android devices to connect at the same

Supports three major desktop platforms, GNU/Linux, Windows and MacOS.

It focuses on:

- **lightness** (native, displays only the device screen)
- **performance** (30~60fps)
- **quality** (1920×1080 or above)
- **low latency** ([35~70ms][lowlatency])
- **low startup time** (~1 second to display the first image)
- **non-intrusiveness** (nothing is left installed on the device)

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

![win](screenshot/win.png)

![mac](screenshot/mac.jpg)
Expand Down Expand Up @@ -150,13 +161,25 @@ Real-time mouse and keyboard control Android device
- Install apk: drag and drop apk to the video window to install
- Transfer files: Drag files to the video window to send files to Android devices
- Background recording: record only, no display interface
- Copy-paste

It is possible to synchronize clipboards between the computer and the device, in
both directions:

- `Ctrl`+`c` copies the device clipboard to the computer clipboard;
- `Ctrl`+`Shift`+`v` copies the computer clipboard to the device clipboard;
- `Ctrl`+`v` _pastes_ the computer clipboard as a sequence of text events (but
breaks non-ASCII characters).

## TODO
[TODO](docs/TODO.md)

## FAQ
[FAQ](docs/FAQ.md)

## DEVELOP
[DEVELOP](docs/DEVELOP.md)

## Why develop QtScrcpy?
There are several reasons for this, and the proportions are arranged from large to small:
1. In the process of learning Qt, you need a project to combat
Expand All @@ -176,9 +199,10 @@ Try to provide all the dependencies and make it easy to compile.

### Android (If you do not need to modify the requirements, you can use the built-in scrcpy-server directly)
1. Set up an Android development environment on the target platform
2. Open the server project in the project root directory using Android Studio
3. Build it
4. After compiling apk, rename it to scrcpy-server and replace third_party/scrcpy-server
2. Open server project in project root with Android Studio
3. The first time you open it, if you do not have the corresponding version of gradle, you will be prompted to find gradle, whether to upgrade gradle and create it. Select Cancel. After canceling, you will be prompted to select the location of the existing gradle. You can also cancel it (it will download automatically).
4. Edit the code as needed, but of course you do n’t need to.
4. After compiling the apk, rename it to scrcpy-server and replace third_party/scrcpy-server.

## Licence
Since it is based on scrcpy, respect its Licence
Expand Down
23 changes: 22 additions & 1 deletion README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ QtScrcpy可以通过USB(或通过TCP/IP)连接Android设备,并进行显示和

同时支持GNU/Linux,Windows和MacOS三大主流桌面平台

它专注于:

- **精致** (仅显示设备屏幕)
- **性能** (30~60fps)
- **质量** (1920×1080以上)
- **低延迟** ([35~70ms][低延迟])
- **快速启动** (1s内就可以看到第一帧图像)
- **非侵入性** (不在设备上安装任何软件)

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


![win](screenshot/win.png)

![mac](screenshot/mac.jpg)
Expand Down Expand Up @@ -158,13 +170,22 @@ Mac OS平台,你可以直接使用我编译好的可执行程序:
- 安装apk:拖拽apk到视频窗口即可安装
- 传输文件:拖拽文件到视频窗口即可发送文件到Android设备
- 后台录制:只录制,不显示界面
- 复制粘贴

在计算机和设备之间双向同步剪贴板:
- `Ctrl` + `c`将设备剪贴板复制到计算机剪贴板;
- `Ctrl` + `Shift` + `v`将计算机剪贴板复制到设备剪贴板;
- `Ctrl` +`v` 将计算机剪贴板作为一系列文本事件发送到设备(不支持非ASCII字符)。

## TODO
[后期计划](docs/TODO.md)

## FAQ
[常见问题说明](docs/FAQ.md)

## 开发者
[开发者相关](docs/DEVELOP.md)

## 为什么开发QtScrcpy?
综合起来有以下几个原因,比重从大到小排列:
1. 学习Qt的过程中需要一个项目实战一下
Expand All @@ -177,7 +198,7 @@ Mac OS平台,你可以直接使用我编译好的可执行程序:
尽量提供了所有依赖资源,方便傻瓜式编译。

### PC端
1. 目标平台上搭建Qt开发环境(Qt >= 5.9.7, vs >= 2015 (不支持mingw))
1. 目标平台上搭建Qt开发环境(Qt >= 5.9.7, vs >= 2015 (**不支持mingw**))
2. 克隆该项目
3. 使用QtCreator打开项目根目录all.pro
4. 编译,运行即可
Expand Down
6 changes: 6 additions & 0 deletions config/config.ini
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
[common]
# 窗口标题
WindowTitle=QtScrcpy
# 录制文件路径
RecordPath=
# 最大fps(仅支持Android 10以上)
MaxFps=60
# scrcpy-server的版本号(不要修改)
ServerVersion=1.12.1
# 是否显示手机皮肤,0不显示
UseSkin=1
# 视频解码方式:-1 自动,0 软解,1 dx硬解,2 opengl硬解
UseDesktopOpenGL=-1
Loading

0 comments on commit 610175c

Please sign in to comment.