From fb61b779a6da299b1f93ec598b2332af9d387416 Mon Sep 17 00:00:00 2001 From: Romain Vimont Date: Mon, 13 Mar 2023 08:40:31 +0100 Subject: [PATCH] Add references to prerequisites Users sometimes only read the OS-specific instructions, they must be aware of the prerequisites. --- README.md | 2 +- doc/linux.md | 2 ++ doc/macos.md | 2 ++ doc/windows.md | 2 ++ 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 858ba843..2dfb6686 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Its features include: - [OTG mode](doc/hid-otg.md#otg) - and more… -## Requirements +## Prerequisites The Android device requires at least API 21 (Android 5.0). diff --git a/doc/linux.md b/doc/linux.md index 3b0c560d..bc354959 100644 --- a/doc/linux.md +++ b/doc/linux.md @@ -61,6 +61,8 @@ _See [build.md](build.md) to build and install the app manually._ ## Run +_Make sure that your device meets the [prerequisites](/README.md#prerequisites)._ + Once installed, run from a terminal: ```bash diff --git a/doc/macos.md b/doc/macos.md index 3092dbdc..35d90e9d 100644 --- a/doc/macos.md +++ b/doc/macos.md @@ -29,6 +29,8 @@ _See [build.md](build.md) to build and install the app manually._ ## Run +_Make sure that your device meets the [prerequisites](/README.md#prerequisites)._ + Once installed, run from a terminal: ```bash diff --git a/doc/windows.md b/doc/windows.md index 1f0e3b81..521ad45e 100644 --- a/doc/windows.md +++ b/doc/windows.md @@ -38,6 +38,8 @@ _See [build.md](build.md) to build and install the app manually._ ## Run +_Make sure that your device meets the [prerequisites](/README.md#prerequisites)._ + Scrcpy is a command line application: it is mainly intended to be executed from a terminal with command line arguments.