docs: expand README install section (direct + adb) - #73
Merged
Conversation
Adds clear end-user install instructions ahead of the v0.4.0 release: - Method 1: download the APK from GitHub Releases on the phone + allow install-from-unknown-sources. - Method 2: sideload via adb install from a computer. Plus first-launch download note (~4.5 GB, Wi-Fi, then fully offline; pinned checksums) and device/storage requirements. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…all methods
The README now documents two install methods, and the sideload path is genuinely
download-free (device-tested end-to-end on a clean-slate phone).
push_to_device.sh:
- --all-models: also push the Gemma LLM (filename read from app_config.json), not
just the embedder — the full asset set.
- Write a `.verified` checksum marker for every pushed model (LLM, embedder,
tokenizer), which the app's downloadsDone now requires; without them the app
re-downloads even when files are present. Marker = the app's pinned SHA-256,
written only after the staged file's hash is confirmed to match (fails loudly
otherwise).
- --apk <path>: install the app as part of the same provisioning run.
- Result: `push_to_device.sh --all-models --apk <apk>` installs the app and pushes
every asset so the phone opens ready with ZERO on-device downloads.
sync_models.sh:
- Fix `${auth[@]}` "unbound variable" crash under `set -u` on macOS bash 3.2 when
no HF_TOKEN is set (the common case) — staging was broken.
README:
- Method 1 (online): install APK, ~4.5 GB first-launch download.
- Method 2 (fully offline): stage once on a computer, push app + all assets over
USB; no phone internet. One certain command path each.
Verified on device (clean uninstall + wipe → stage → push → launch): app opens
straight to chat, EmbeddingGemma retrieves 3 guidelines, Gemma 4 answers — offline.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds clear two-method install instructions before the v0.4.0 release: (1) download the signed APK from Releases on the phone, (2)
adb installsideload from a computer — plus first-launch download/requirements notes.