summaryrefslogtreecommitdiff
path: root/player-android/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-05-17 15:31:16 +0300
committerPaul Buetow <paul@buetow.org>2026-05-17 15:31:16 +0300
commitc11b7c145fc1b2db6c1ed29a7abd739d0f6cbf3b (patch)
tree4db8478fded8f3e1ad832b2788f6f82888a8f3ad /player-android/README.md
parent914bd7cd6aa14e839332a98d91c30b19865b0cf2 (diff)
Add player-android/ Flutter skeleton
Diffstat (limited to 'player-android/README.md')
-rw-r--r--player-android/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/player-android/README.md b/player-android/README.md
new file mode 100644
index 0000000..e365f9b
--- /dev/null
+++ b/player-android/README.md
@@ -0,0 +1,16 @@
+# Player Android
+
+Flutter Android client scaffold for the Player server.
+
+## Quickstart
+
+When Flutter is installed, finish or refresh the generated Android project files:
+
+```sh
+cd player-android
+flutter create --org zone.foo --project-name player_android --platforms=android --description 'Player Android client' .
+flutter analyze
+flutter build apk --debug
+```
+
+The REST API contract lives in [../player-server/docs/api.md](../player-server/docs/api.md).