aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-22 11:27:14 +0200
committerDanilo M. <danix@danix.xyz>2026-10-22 11:27:14 +0200
commit563e7af818ce1cf5ce37ca5f680e3cc630ad2922 (patch)
tree25690c1c262164cac0e64fdd757bceece04f3608 /README.md
parent5c116d4ba7a59ac5a5c9acbdb166248a97c42b81 (diff)
downloadmygram-droid-563e7af818ce1cf5ce37ca5f680e3cc630ad2922.tar.gz
mygram-droid-563e7af818ce1cf5ce37ca5f680e3cc630ad2922.zip
Document build, deploy and test commands
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 288ba80..77e73f7 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,19 @@ the TV remote.
## Status
-Early development. Nothing to install yet.
+Early development. Builds; on-device testing in progress.
+
+## Build and install
+
+Requires Docker and adb on the host; nothing else is installed.
+
+ ./build.sh # debug APK in app/build/outputs/apk/debug/
+ ./build.sh test # JVM unit tests
+ ./deploy.sh # build, install on the TV over wireless adb, launch
+
+On first launch the app scans the local network for Foldergram on port
+4141, or takes a URL, then asks for the viewer password if the instance
+has one.
## Planned features
@@ -17,6 +29,10 @@ Early development. Nothing to install yet.
- D-pad navigation throughout
- Server address configured on first launch
+## Credits
+
+Icons: [Material Icons](https://fonts.google.com/icons), Apache License 2.0.
+
## License
Copyright (C) 2026 Danilo M. <danix@danix.xyz>