Skip to content

docs: improve README structure, developer guide, and download access - #3

Merged
Adrian463588 merged 1 commit into
mainfrom
Fix-issue
Oct 13, 2026
Merged

Adrian463588 merged 1 commit into
mainfrom
Fix-issue

Conversation

@Adrian463588

Copy link
Copy Markdown
Owner

Summary

Restructure README.md for developer readability and clear user onboarding while strictly preserving all existing sensor contracts, build commands, and publication policies:

  • Architecture Overview: Adds high-level multi-module scope table (:mobile, :wear, :shared).
  • Direct APK Downloads: Prominently highlights direct download links for latest v1.3.1 (mobile-debug.apk and wear-debug.apk).
  • Version History: Retains complete historical releases table (v1.3.1, v1.3.0, debug-2026-10-01).
  • Structured Operating Guide: Organizes usage into prerequisites, step-by-step workflow, and fail-safe lifecycle invariants (15s lease, terminal stop, Polar retry).
  • Clear Developer Tooling & Gates: Separates JDK/SDK prerequisites, Gradle test/lint/build commands, and publication audit scripts.
  • Documentation & References: Keeps links to AGENTS.md, OpenSpec specs, SESSION_CONTROL_FIX_PLAN.md, and MAIN_MERGE_AUDIT.md.

Restructure README.md for developer clarity while preserving all sensor contracts, build commands, and publication policies:
- Add high-level multi-module architecture table (:mobile, :wear, :shared).
- Highlight direct download links for latest v1.3.1 phone and watch APKs.
- Organize step-by-step usage guide into prerequisites, operations, and fail-safes.
- Group tooling requirements and verification commands clearly.
- Preserve all historical releases and hardware acceptance boundaries.

Co-Authored-By: Codex (GPT-6) <noreply@openai.com>
@Adrian463588
Adrian463588 merged commit a965897 into main Oct 13, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant