From e35cf51c1481e626c02c0201e53ab806d91806e2 Mon Sep 17 00:00:00 2001 From: "[pause, if needed]" <91560320+e1e0@users.noreply.github.com> Date: Thu, 10 Mar 2022 20:07:13 +0000 Subject: [PATCH 1/4] Update README.md --- README.md | 40 +++++++++++++++------------------------- 1 file changed, 15 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 1c5cfd23..700a57e8 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ _pronounced "**scr**een **c**o**py**"_ [Read in another language](#translations) This application provides display and control of Android devices connected via -USB (or [over TCP/IP](#tcpip-wireless)). It _does not require_ any root access. +USB (or [over TCP/IP](#tcpip-wireless)). It does **not** require any _root_ access. It works on _GNU/Linux_, _Windows_ and _macOS_. ![screenshot](assets/screenshot-debian-600.jpg) @@ -66,36 +66,29 @@ control it using keyboard and mouse. brew install android-platform-tools ``` -### More - -**Linux > Arch Linux** +### Linux +- Arch Linux ``` pacman -S scrcpy ``` -**Linux > [Snap] package** +- [Snap] package, available at [`scrcpy`](https://snapstats.org/snaps/scrcpy) -[`scrcpy`](https://snapstats.org/snaps/scrcpy) +- Fedora / [COPR] package, available at [`scrcpy`](https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/) -[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager) - -**Linux > Fedora / [COPR] package** - -[`scrcpy`](https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/) +- Gentoo / [Ebuild], available at [`scrcpy/`](https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy). [COPR]: https://fedoraproject.org/wiki/Category:Copr -**Linux > Gentoo / [Ebuild]** - -Available at [`scrcpy/`](https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy). - [Ebuild]: https://wiki.gentoo.org/wiki/Ebuild +[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager) -**Windows > archive** -For Windows, for simplicity, a prebuilt archive with all the dependencies +### Windows + +For simplicity, a prebuilt archive with all the dependencies (including `adb`) is available: - [`scrcpy-win64-v1.23.zip`][direct-win64] @@ -103,8 +96,6 @@ For Windows, for simplicity, a prebuilt archive with all the dependencies [direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v1.23/scrcpy-win64-v1.23.zip -**Windows > Chocolatey** - It is also available in [Chocolatey](https://chocolatey.org/): ```bash @@ -112,7 +103,7 @@ choco install scrcpy choco install adb # if you don't have it yet ``` -**Windows > Scoop ()**: +and Scoop ()**: ```bash scoop install scrcpy @@ -120,18 +111,17 @@ scoop install adb # if you don't have it yet ``` -**macOS > in [MacPorts](https://www.macports.org/)** +### macOS, in [MacPorts](https://www.macports.org/) -(which sets up adb for you) +(sets up adb for you) ```bash sudo port install scrcpy ``` +### Manual build -**Manual build** - -You could build manually from sources: [BUILD.md](BUILD.md). [Simplified process](BUILD.md#simple). +You could build manually from sources: [BUILD.md](BUILD.md), [Simplified process](BUILD.md#simple). ## Run From c4e22abd811ff5e3594e9327ecf6516bb69c0580 Mon Sep 17 00:00:00 2001 From: "[pause, if needed]" <91560320+e1e0@users.noreply.github.com> Date: Thu, 10 Mar 2022 20:54:12 +0000 Subject: [PATCH 2/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 700a57e8..7dcf3683 100644 --- a/README.md +++ b/README.md @@ -79,12 +79,12 @@ pacman -S scrcpy - Gentoo / [Ebuild], available at [`scrcpy/`](https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy). +[Snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager) + [COPR]: https://fedoraproject.org/wiki/Category:Copr [Ebuild]: https://wiki.gentoo.org/wiki/Ebuild -[snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager) - ### Windows @@ -103,7 +103,7 @@ choco install scrcpy choco install adb # if you don't have it yet ``` -and Scoop ()**: +and Scoop (): ```bash scoop install scrcpy From 0deba20b92c0d01103c1e374c06a3a1b078e5292 Mon Sep 17 00:00:00 2001 From: "[pause, if needed]" <91560320+e1e0@users.noreply.github.com> Date: Tue, 22 Mar 2022 01:17:29 +0000 Subject: [PATCH 3/4] Update README.md * do `sudo ln --symbolic ### /usr/local/bin/adb` for Android Studio `adb` to be `adb` command. --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7dcf3683..fddd5003 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ _pronounced "**scr**een **c**o**py**"_ [Read in another language](#translations) This application provides display and control of Android devices connected via -USB (or [over TCP/IP](#tcpip-wireless)). It does **not** require any _root_ access. +USB (or [over TCP/IP](#tcpip-wireless)). It does **not** _require any root access_. It works on _GNU/Linux_, _Windows_ and _macOS_. ![screenshot](assets/screenshot-debian-600.jpg) @@ -60,6 +60,7 @@ control it using keyboard and mouse. - Windows: [download][direct-win64] - macOS ([Homebrew](https://brew.sh/)): `brew install scrcpy` \* You need `adb`, accessible from your `PATH` *\*. + - [From sources](#manual-build) *\* ```bash @@ -73,11 +74,11 @@ brew install android-platform-tools pacman -S scrcpy ``` -- [Snap] package, available at [`scrcpy`](https://snapstats.org/snaps/scrcpy) +- [Snap] package, available at -- Fedora / [COPR] package, available at [`scrcpy`](https://copr.fedorainfracloud.org/coprs/zeno/scrcpy/) +- Fedora / [COPR] package, available at -- Gentoo / [Ebuild], available at [`scrcpy/`](https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy). +- Gentoo / [Ebuild], available at . [Snap]: https://en.wikipedia.org/wiki/Snappy_(package_manager) @@ -126,7 +127,8 @@ You could build manually from sources: [BUILD.md](BUILD.md), [Simplified process ## Run -Plug in an Android device, **connect with [`adb`](https://developer.android.com/studio/command-line/adb)** and execute: +Plug in an Android device, **connect with [`adb`](https://developer.android.com/studio/command-line/adb)** +and execute: ```bash scrcpy @@ -141,9 +143,6 @@ scrcpy --help ## Custom paths -(Linux): For Android Studio (SDK) `adb` to be `adb` command, do `sudo ln --symbolic ### /usr/local/bin/adb`. -"###" should be a path to your Android Debug Bridge file. - To use a specific _adb_ binary, configure its path in the environment variable `ADB`: ```bash @@ -332,10 +331,8 @@ For example, you could capture the video within [OBS]. #### Buffering -It is possible to add buffering. This increases latency but reduces jitter (see -[#2464]). - -[#2464]: https://github.com/Genymobile/scrcpy/issues/2464 +It is possible to add buffering. This increases latency but reduces jitter +(see [#2464](https://github.com/Genymobile/scrcpy/issues/2464)). The option is available for display buffering: From 4c79839303cb9716f4fb789619d2b48d587761ec Mon Sep 17 00:00:00 2001 From: "[pause, if needed]" <91560320+e1e0@users.noreply.github.com> Date: Tue, 22 Mar 2022 01:49:26 +0000 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fddd5003..a9def1bb 100644 --- a/README.md +++ b/README.md @@ -1068,7 +1068,7 @@ A colleague challenged me to find a name as unpronounceable as [gnirehtet]. ## How to build? -See [BUILD]. +See [this](BUILD.md). ## Common issues