|
| 1 | +# Mac Snap Installation Guide |
| 2 | + |
| 3 | +Welcome to Mac Snap! This guide will help you install and set up the ultimate window management tool for macOS. |
| 4 | + |
| 5 | +## 📥 Installation Methods |
| 6 | + |
| 7 | +### Method 1: DMG Installer (Recommended) |
| 8 | + |
| 9 | +1. **Download the latest release:** |
| 10 | + - Visit the [Mac Snap Releases](https://github.com/nicolusmaluleke/MacSnapper/releases) page |
| 11 | + - Download the latest `MacSnap-Installer-X.X.X.dmg` file |
| 12 | + |
| 13 | +2. **Install the app:** |
| 14 | + - Double-click the downloaded DMG file |
| 15 | + - Drag "Mac Snap.app" to the Applications folder |
| 16 | + - Eject the DMG when done |
| 17 | + |
| 18 | +3. **Launch and setup:** |
| 19 | + - Open Mac Snap from Applications folder |
| 20 | + - Grant Accessibility permissions when prompted |
| 21 | + - Configure your preferred hotkeys |
| 22 | + |
| 23 | +### Method 2: Build from Source |
| 24 | + |
| 25 | +If you're a developer or want to build the latest version: |
| 26 | + |
| 27 | +```bash |
| 28 | +# Clone the repository |
| 29 | +git clone https://github.com/nicolusmaluleke/MacSnapper.git |
| 30 | +cd MacSnapper |
| 31 | + |
| 32 | +# Build using Xcode |
| 33 | +xcodebuild -project MacSnapper.xcodeproj \ |
| 34 | + -scheme MacSnapper \ |
| 35 | + -configuration Release \ |
| 36 | + clean build |
| 37 | + |
| 38 | +# Or create a DMG installer |
| 39 | +chmod +x scripts/create_dmg.sh |
| 40 | +./scripts/create_dmg.sh |
| 41 | +``` |
| 42 | + |
| 43 | +### Method 3: Direct App Bundle |
| 44 | + |
| 45 | +For quick testing (unsigned version): |
| 46 | + |
| 47 | +1. Download the app bundle from GitHub Actions artifacts |
| 48 | +2. Move to Applications folder |
| 49 | +3. Right-click → Open (to bypass Gatekeeper) |
| 50 | +4. Grant required permissions |
| 51 | + |
| 52 | +## 🔐 Required Permissions |
| 53 | + |
| 54 | +Mac Snap needs these permissions to function: |
| 55 | + |
| 56 | +### Accessibility Permission (Required) |
| 57 | +- **Purpose:** Control and resize windows |
| 58 | +- **How to grant:** |
| 59 | + 1. System Preferences → Security & Privacy → Privacy |
| 60 | + 2. Select "Accessibility" from the left sidebar |
| 61 | + 3. Click the lock icon and enter your password |
| 62 | + 4. Check the box next to "Mac Snap" |
| 63 | + |
| 64 | +### Screen Recording Permission (Optional) |
| 65 | +- **Purpose:** Enhanced window detection on some systems |
| 66 | +- **Note:** Only required on macOS 10.15+ with certain security settings |
| 67 | + |
| 68 | +## ⚙️ Initial Setup |
| 69 | + |
| 70 | +### 1. Configure Global Hotkeys |
| 71 | + |
| 72 | +Default hotkeys: |
| 73 | +- `⌘ + ←` - Snap left half |
| 74 | +- `⌘ + →` - Snap right half |
| 75 | +- `⌘ + ↑` - Maximize window |
| 76 | +- `⌘ + ↓` - Center window |
| 77 | + |
| 78 | +To customize: |
| 79 | +1. Open Mac Snap preferences |
| 80 | +2. Go to "Shortcuts" tab |
| 81 | +3. Click on any hotkey to change it |
| 82 | +4. Test your new hotkeys |
| 83 | + |
| 84 | +### 2. Choose Your Operating Mode |
| 85 | + |
| 86 | +**Menu Bar Mode (Recommended):** |
| 87 | +- App runs in background |
| 88 | +- Access via menu bar icon |
| 89 | +- Minimal system impact |
| 90 | + |
| 91 | +**Window Mode:** |
| 92 | +- Traditional app window |
| 93 | +- Full settings interface |
| 94 | +- Easy access to all features |
| 95 | + |
| 96 | +### 3. Premium Features (Optional) |
| 97 | + |
| 98 | +Unlock advanced features: |
| 99 | +- Advanced snapping patterns (thirds, custom zones) |
| 100 | +- Custom keyboard shortcuts |
| 101 | +- Multi-monitor window management |
| 102 | +- Window presets and exclusions |
| 103 | + |
| 104 | +**Free Trial:** 7 days of all premium features |
| 105 | +**Subscription:** $4.99/month or $39.99/year |
| 106 | + |
| 107 | +## 🔧 Troubleshooting |
| 108 | + |
| 109 | +### Common Issues |
| 110 | + |
| 111 | +**App won't launch:** |
| 112 | +- Check that you've granted Accessibility permission |
| 113 | +- Try right-clicking and selecting "Open" (for unsigned builds) |
| 114 | +- Restart your Mac if permissions were just granted |
| 115 | + |
| 116 | +**Hotkeys not working:** |
| 117 | +- Verify Accessibility permission is granted |
| 118 | +- Check for conflicting system shortcuts |
| 119 | +- Try different key combinations |
| 120 | + |
| 121 | +**Window snapping not precise:** |
| 122 | +- Ensure you're using the latest version |
| 123 | +- Check for conflicting window management apps |
| 124 | +- Try toggling the Accessibility permission off and on |
| 125 | + |
| 126 | +### Performance Tips |
| 127 | + |
| 128 | +1. **Enable "Launch at Login"** for seamless experience |
| 129 | +2. **Use Menu Bar mode** for better performance |
| 130 | +3. **Exclude problematic apps** in settings if needed |
| 131 | +4. **Keep the app updated** for latest improvements |
| 132 | + |
| 133 | +## 🆘 Getting Help |
| 134 | + |
| 135 | +- **Issues:** [GitHub Issues](https://github.com/nicolusmaluleke/MacSnapper/issues) |
| 136 | +- **Feature Requests:** [GitHub Discussions](https://github.com/nicolusmaluleke/MacSnapper/discussions) |
| 137 | +- **Email Support:** nicolusmaluleke@gmail.com |
| 138 | + |
| 139 | +## 🔄 Updating |
| 140 | + |
| 141 | +### Automatic Updates (Coming Soon) |
| 142 | +The app will check for updates automatically and notify you. |
| 143 | + |
| 144 | +### Manual Updates |
| 145 | +1. Download the latest DMG from releases |
| 146 | +2. Replace the old app in Applications folder |
| 147 | +3. Your settings will be preserved |
| 148 | + |
| 149 | +## 🗑️ Uninstalling |
| 150 | + |
| 151 | +To completely remove Mac Snap: |
| 152 | + |
| 153 | +1. **Quit the app:** |
| 154 | + - Right-click menu bar icon → Quit |
| 155 | + - Or force quit if needed |
| 156 | + |
| 157 | +2. **Remove the app:** |
| 158 | + ```bash |
| 159 | + rm -rf /Applications/Mac\ Snap.app |
| 160 | + ``` |
| 161 | + |
| 162 | +3. **Remove preferences (optional):** |
| 163 | + ```bash |
| 164 | + rm -rf ~/Library/Preferences/com.nicksoftware.macsnap.plist |
| 165 | + rm -rf ~/Library/Application\ Support/Mac\ Snap/ |
| 166 | + ``` |
| 167 | + |
| 168 | +4. **Remove Accessibility permission:** |
| 169 | + - System Preferences → Security & Privacy → Privacy |
| 170 | + - Select "Accessibility" and remove Mac Snap |
| 171 | + |
| 172 | +--- |
| 173 | + |
| 174 | +**Enjoy effortless window management with Mac Snap! 🪟✨** |
0 commit comments