aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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