Skip to content

Commit c214fa0

Browse files
authored
docs: Restructure Quick Start — DMG as preferred install, add permissions guide (#39)
* docs: restructure Quick Start with DMG as preferred install method - 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 * docs: add install script option under Build from Source Add the ./scripts/install.sh workflow as an alternative for developers who prefer CLI commands (vocamac & vocamac-build).
1 parent 85d2d57 commit c214fa0

1 file changed

Lines changed: 48 additions & 12 deletions

File tree

README.md

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,35 +104,71 @@ Same accuracy, dramatically better Apple platform integration.
104104
## 📋 Requirements
105105

106106
- **macOS 13 (Ventura)** or later
107-
- **Xcode 15+** or Swift 5.9+ (for building)
108-
- **Microphone permission** - For audio capture
109-
- **Accessibility permission** - For global hotkeys and text injection
107+
- **Apple Silicon** (M1/M2/M3/M4)
108+
- **Xcode 15+** or Swift 5.9+ (only for building from source)
109+
110+
### Permissions
111+
112+
VocaMac requires three macOS permissions:
113+
114+
| Permission | Why |
115+
|---|---|
116+
| **Microphone** | Capture your voice for transcription |
117+
| **Accessibility** | Global hotkeys and text injection into apps |
118+
| **Input Monitoring** | Detect hotkey presses system-wide |
119+
120+
> **Note:** After granting Input Monitoring, a restart of VocaMac is required for it to take effect.
110121
111122
---
112123

113124
## 🚀 Quick Start
114125

115-
### Build from Source
126+
### Option 1: Download DMG (Recommended)
127+
128+
1. **Download** the latest `VocaMac-x.x.x-arm64.dmg` from the [Releases page](https://github.com/jatinkrmalik/vocamac/releases)
129+
2. **Open** the DMG and drag VocaMac to Applications
130+
3. **Remove quarantine** (required because VocaMac is not yet notarized with Apple):
131+
```bash
132+
xattr -cr /Applications/VocaMac.app
133+
```
134+
4. **Open** VocaMac from Applications (right-click → Open on first launch)
135+
5. **Grant permissions** — Microphone, Accessibility, and Input Monitoring when prompted
136+
137+
### Option 2: Build from Source
116138

117139
```bash
118140
# Clone the repository
119141
git clone https://github.com/jatinkrmalik/vocamac.git
120142
cd vocamac
121143

122-
# Build (first build downloads WhisperKit dependency - ~1 min)
123-
swift build -c release
144+
# Build the app bundle
145+
./scripts/build.sh
124146

125-
# Run VocaMac
126-
swift run -c release VocaMac
147+
# Launch VocaMac
148+
open VocaMac.app
127149
```
128150

151+
**Or use the install script** for a CLI-based workflow:
152+
153+
```bash
154+
# Build + install `vocamac` command to ~/.local/bin
155+
./scripts/install.sh
156+
157+
# Launch in background
158+
vocamac &
159+
160+
# Rebuild anytime after pulling updates
161+
vocamac-build
162+
```
163+
164+
> **Permissions note:** When running from terminal, macOS assigns permissions to your **terminal app** (Terminal, iTerm2, etc.) rather than VocaMac itself. Grant Microphone, Accessibility, and Input Monitoring to your terminal app instead.
165+
129166
### First Launch
130167

131168
1. **VocaMac appears in your menu bar** (microphone icon, no Dock icon)
132-
2. **Grant Microphone permission** when prompted
133-
3. **Grant Accessibility permission** - VocaMac will guide you to System Settings → Privacy & Security → Accessibility
134-
4. **First model download** - WhisperKit automatically downloads the recommended model for your device (~40-500MB depending on hardware)
135-
5. **Start dictating** - Hold the **Right Option** key, speak, and release. Your words appear at the cursor!
169+
2. **Grant permissions** — Microphone, Accessibility, and Input Monitoring (see [Permissions](#permissions) above)
170+
3. **First model download** — WhisperKit automatically downloads the recommended model for your device (~40–500 MB depending on hardware)
171+
4. **Start dictating** — Hold the **Right Option** key, speak, and release. Your words appear at the cursor!
136172

137173
---
138174

0 commit comments

Comments
 (0)