Skip to content

Document Windows app setup command#7787

Merged
kodjima33 merged 1 commit into
BasedHardware:mainfrom
tianmind-studio:codex/app-readme-windows-setup
Jun 11, 2026
Merged

Document Windows app setup command#7787
kodjima33 merged 1 commit into
BasedHardware:mainfrom
tianmind-studio:codex/app-readme-windows-setup

Conversation

@tianmind-studio

Copy link
Copy Markdown
Contributor

Summary

  • Add the Windows PowerShell setup command to app/README.md.
  • Keep the existing macOS/Linux bash setup.sh commands for iOS and Android.
  • Clarify that iOS setup requires macOS/Xcode, so Windows developers should use the Android setup path.

Windows context

The repository already includes app/setup/scripts/setup.ps1, but the app README only showed the bash setup script. This gives Windows contributors a direct setup entrypoint from the local app README.

Testing

  • Verified app/setup/scripts/setup.ps1 exists.
  • Verified app/setup.sh exists.
  • git diff --check

Docs-only change; no app build was run.

@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This docs-only PR adds a Windows PowerShell setup command to app/README.md, giving Windows contributors a direct entrypoint that was previously undocumented despite setup.ps1 already existing in the repo. It also adds a note clarifying that iOS setup requires macOS/Xcode.

  • The PowerShell path .\\setup\\scripts\\setup.ps1 android correctly resolves from the app/ directory (after step 1's cd app) and the script accepts android as a valid argument.
  • The two code blocks (bash and PowerShell) sit side-by-side in step 2 without an explicit "OR" separator; they rely on the inline comments (# macOS/Linux and # Windows PowerShell) to signal they are mutually exclusive alternatives — this is legible but could momentarily confuse readers who skim past comments.
  • Steps 3 and 4 still use bash-only syntax (cd ~/.ssh; ssh-add and flutter run), which is a pre-existing gap not introduced by this PR.

Confidence Score: 5/5

Documentation-only change that adds a correct and already-existing script path; safe to merge.

The referenced script exists at the documented path, accepts the android argument, and the cd app prerequisite step is already in place. No code is modified.

No files require special attention.

Important Files Changed

Filename Overview
app/README.md Adds a Windows PowerShell setup block for Android and a clarifying note about iOS requiring macOS/Xcode. Path .\setup\scripts\setup.ps1 correctly resolves from app/ after the cd app step.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer: cd app] --> B{Operating System?}
    B -->|macOS / Linux| C{Target Platform?}
    B -->|Windows| D[PowerShell: .\setup\scripts\setup.ps1 android]
    C -->|iOS| E[bash setup.sh ios]
    C -->|Android| F[bash setup.sh android]
    D --> G[Android device setup]
    E --> H[iOS device setup - requires Xcode]
    F --> G
Loading

Reviews (1): Last reviewed commit: "Document Windows app setup command" | Re-trigger Greptile

@kodjima33 kodjima33 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Docs verified: app/setup/scripts/setup.ps1 exists on main; Windows setup command correct

@kodjima33 kodjima33 merged commit 4bbde4e into BasedHardware:main Jun 11, 2026
2 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.

2 participants