aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLena <lena@omega>2026-07-01 00:00:00 +0000
committerLena <lena@omega>2026-07-01 00:00:00 +0000
commitbddc306de0cebde44f99b3a9c4ddba130946bef3 (patch)
treef677ea466def5b06507aec07d169cebc9a1d2ace
parent7619bfd37ed6aef3fbd3dbf8b93e926001a3f968 (diff)
downloadscrcpy-android-bddc306de0cebde44f99b3a9c4ddba130946bef3.tar.gz
readme: document vendor/scrcpy and fastlane, fix build steps
The layout section did not mention the scrcpy submodule (used by the F-Droid build to compile scrcpy-server from source) or the fastlane store metadata. The build steps told everyone to run fetch-vendor, but the vendored tree is committed; the script is only for bumping the pin, and running it mutates local history via git subtree.
-rw-r--r--README9
1 files changed, 8 insertions, 1 deletions
diff --git a/README b/README
index a58e244..780b5d5 100644
--- a/README
+++ b/README
@@ -19,11 +19,13 @@ How to run it
Prerequisites: Android Studio (Iguana or newer) or JDK 17 + Android SDK with
platform-tools and platform 35.
- ./scripts/fetch-vendor # pull libadb-android into vendor/
./scripts/update-server # download + verify pinned scrcpy-server.jar
./gradlew :app:assembleDebug # build debug APK
adb install app/build/outputs/apk/debug/app-debug.apk
+The vendored libadb-android tree is committed; scripts/fetch-vendor is
+only needed when bumping its pinned tag, not for building.
+
For a signed release APK, see "How to build a release APK" below.
On the target device: Settings -> Developer options -> Wireless debugging ->
@@ -124,6 +126,11 @@ Layout
------
app/ Android module (Java)
vendor/libadb-android/ vendored libadb module, pinned tag, plus licenses
+ vendor/scrcpy git submodule pinned at the scrcpy release the
+ server jar comes from; F-Droid builds the jar
+ from it. Not needed for local builds.
+ fastlane/ F-Droid store metadata (description, icon,
+ screenshots)
scripts/ POSIX sh, set -eu
gradle/, gradlew* Gradle 8.9 wrapper
LICENSE Apache-2.0