Skip to content

docs: Restructure Quick Start — DMG as preferred install, add permissions guide - #39

Merged
jatinkrmalik merged 2 commits into
mainfrom
docs/readme-quick-start-update
Mar 5, 2026
Merged

docs: Restructure Quick Start — DMG as preferred install, add permissions guide#39
jatinkrmalik merged 2 commits into
mainfrom
docs/readme-quick-start-update

Conversation

@jatinkrmalik

Copy link
Copy Markdown
Member

Changes

  • DMG as Option 1 (Recommended) — Download from Releases, drag to Applications, remove quarantine, grant permissions
  • Build from Source as Option 2 — With note that permissions go to the terminal app, not VocaMac
  • Permissions table — All 3 required permissions (Microphone, Accessibility, Input Monitoring) with explanations
  • Input Monitoring restart note — Calls out that app restart is needed after granting
  • Updated Requirements — Added Apple Silicon, clarified Xcode is only needed for source builds
  • Simplified First Launch — References the permissions section instead of repeating

Makes it as easy as possible for new users to get started with the v0.1.0 release.

- Add DMG download as Option 1 (Recommended) with quarantine removal steps
- Move Build from Source to Option 2 with permissions note for terminal apps
- Add Permissions table with all 3 required permissions (Mic, Accessibility, Input Monitoring)
- Add Input Monitoring restart note
- Update Requirements to include Apple Silicon and clarify Xcode is only for source builds
- Simplify First Launch steps to reference permissions section
Add the ./scripts/install.sh workflow as an alternative for developers
who prefer CLI commands (vocamac & vocamac-build).
@jatinkrmalik
jatinkrmalik merged commit c214fa0 into main Mar 5, 2026
1 check passed
@jatinkrmalik
jatinkrmalik deleted the docs/readme-quick-start-update branch August 22, 2026 05:32
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