Skip to content

Update dev readme#8491

Open
Crosse wants to merge 7 commits intomainfrom
update-docs
Open

Update dev readme#8491
Crosse wants to merge 7 commits intomainfrom
update-docs

Conversation

@Crosse
Copy link
Contributor

@Crosse Crosse commented Feb 23, 2026

Summary

  • Rewrote README-dev.md to fix outdated information, missing prerequisites, and ambiguous instructions that were causing build failures for new contributors.
  • Added install-android-sdk Makefile target as a single source of truth for Android SDK component versions, replacing the stale hardcoded versions in the old README

Changes

README-dev.md

  • Added global prerequisites section (Flutter 3.35.6, Go 1.25.4)
  • Added "Getting Started" section covering flutter pub get, which must be run after cloning and after dependency changes
  • macOS: added xcodebuild -runFirstLaunch one-time setup step; replaced manual gomobile commands with make install-macos-deps / make install-gomobile
  • Android: corrected NDK version (23.x27.0.12077973) and CMake version (3.18.13.22.1) to match CI; added Java 17+ prerequisite; added NDK environment variable instructions; replaced raw sdkmanager invocation with make install-android-sdk
  • iOS: replaced manual go install / gomobile init commands with make install-ios-deps
  • General: added context explaining what each build step does (Go → native framework → Flutter APK/app)

Makefile

  • Added ANDROID_NDK_VERSION, ANDROID_CMAKE_VERSION, ANDROID_BUILD_TOOLS_VERSION, and ANDROID_PLATFORM variables
  • Added install-android-sdk target that runs sdkmanager with the correct versions and auto-accepts licenses

Test plan

  • Verify make install-android-sdk installs the correct SDK components on a clean Android setup
  • Verify make android-debug produces a valid APK after following the updated instructions end-to-end
  • Verify make macos builds successfully after make install-gomobile on a clean macOS setup
  • Review README prose for clarity

🤖 Generated with Claude Code

Crosse and others added 5 commits February 23, 2026 11:44
- Rewrote README-dev.md to fix outdated versions, missing steps, and
  ambiguous instructions (flutter pub get, xcodebuild -runFirstLaunch,
  gomobile via make targets, Java prereq, NDK env vars)
- Corrected Android NDK version (23.x -> 27.0.12077973) and CMake
  version (3.18.1 -> 3.22.1) to match CI
- Added ANDROID_NDK_VERSION, ANDROID_CMAKE_VERSION,
  ANDROID_BUILD_TOOLS_VERSION, and ANDROID_PLATFORM variables to
  Makefile as the single source of truth for SDK component versions
- Added install-android-sdk Makefile target that runs sdkmanager with
  the correct versions and auto-accepts licenses

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…K tip

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…rdcoding

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jigar-f jigar-f marked this pull request as ready for review March 20, 2026 08:13
Copilot AI review requested due to automatic review settings March 20, 2026 08:13
@jigar-f jigar-f changed the title Update developer docs and add install-android-sdk Makefile target Update dev readme Mar 20, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates contributor-facing developer documentation and centralizes Android SDK component versioning in the Makefile to reduce setup drift vs CI.

Changes:

  • Rewrites README-dev.md with clearer prerequisites, platform setup steps, and build/run guidance.
  • Adds Android SDK version variables and a new install-android-sdk Makefile target to install consistent SDK components.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
README-dev.md Major rewrite of dev docs, including prerequisites and platform build/run instructions.
Makefile Adds Android SDK component version vars + install-android-sdk target.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jigar-f jigar-f requested review from atavism and myleshorton March 20, 2026 10:56
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.

3 participants