aboutsummaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--AGENTS.md13
-rw-r--r--README.md18
2 files changed, 27 insertions, 4 deletions
diff --git a/AGENTS.md b/AGENTS.md
index d190de9..36994f6 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -62,9 +62,16 @@ live instance, do not guess routes or fields.
- Every screen must be fully usable with a D-pad remote (visible focus,
no touch-only controls).
-## Testing
-
-No test suite yet.
+## Building and testing
+
+- `./build.sh` builds the debug APK in Docker (image `mygram-droid-build`),
+ `./build.sh test` runs the JVM unit tests (`LogicTest`), `./deploy.sh`
+ installs on the TV and launches.
+- Package `mygram.droid`. UI is built in code, no layout XML.
+- Verify every UI change on the TV (see Target device).
+- For API probes use a cookie jar in a scratch directory and the viewer
+ password from `/tmp/mygram.pw` (outside the repo, gone after a
+ reboot; ask the user to recreate it).
## Repo facts
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>