Skip to content

Commit ccea8d8

Browse files
committed
docs: update README and installation guide with professional branding - Enhanced README with professional description, logo integration, comprehensive feature sections, app icon generation documentation, updated INSTALLATION_GUIDE with multiple installation methods and troubleshooting
1 parent 74fb3b0 commit ccea8d8

2 files changed

Lines changed: 212 additions & 1 deletion

File tree

INSTALLATION_GUIDE.md

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
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! 🪟✨**

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Mac Snap 🪟
22

3-
A professional macOS window manager built with SwiftUI and Clean Architecture principles. Mac Snap provides powerful window snapping and management capabilities with a beautiful, intuitive interface.
3+
**Professional Window Snapping for macOS**
4+
5+
![Mac Snap Logo](logo.svg)
6+
7+
Mac Snap is a powerful and intuitive window management utility for macOS that makes organizing your workspace effortless. With intelligent window snapping, customizable shortcuts, and a clean interface, Mac Snap helps you maximize productivity by keeping your windows perfectly organized.
48

59
![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)
610
![Platform](https://img.shields.io/badge/Platform-macOS%2014.0+-blue.svg)
@@ -9,6 +13,24 @@ A professional macOS window manager built with SwiftUI and Clean Architecture pr
913

1014
## ✨ Features
1115

16+
### 🎯 Core Functionality
17+
- **Smart Window Snapping**: Snap windows to halves, quarters, thirds, and custom positions
18+
- **Drag & Drop Snapping**: Intuitive window snapping by dragging to screen edges
19+
- **Multi-Monitor Support**: Full support for multiple displays with individual snapping zones
20+
- **Custom Presets**: Create and save custom window arrangements
21+
22+
### 🔧 Customization
23+
- **Global Hotkeys**: Customizable keyboard shortcuts for all snapping actions
24+
- **Exclusion Lists**: Exclude specific applications from snapping
25+
- **Visual Feedback**: Real-time preview of window positions during snapping
26+
- **Menu Bar Integration**: Quick access via menu bar icon
27+
28+
### 💎 Professional Design
29+
- **Modern macOS Interface**: Native SwiftUI design following Apple's Human Interface Guidelines
30+
- **Professional Logo**: Custom-designed gradient app icon with window snapping iconography
31+
- **Clean Architecture**: Built with Domain-Driven Design and SOLID principles
32+
- **Performance Optimized**: Minimal memory footprint and CPU usage
33+
1234
### Core Window Management
1335
- **Precise Window Snapping**: Left/Right halves, quarters, thirds, and custom positions
1436
- **Multiple Screen Support**: Intelligent screen detection and window positioning
@@ -302,6 +324,21 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
302324
- Architecture influenced by Clean Architecture principles by Uncle Bob
303325
- SwiftUI design patterns from Apple's Human Interface Guidelines
304326

327+
## Development
328+
329+
### 🎨 App Icon Generation
330+
The professional app icon is generated from the SVG logo using the included script:
331+
332+
```bash
333+
./scripts/create_app_icon.sh
334+
```
335+
336+
This script:
337+
- Converts the SVG logo to all required macOS icon sizes (16x16 to 1024x1024)
338+
- Creates both 1x and 2x (retina) versions
339+
- Generates the .icns file for the app bundle
340+
- Updates the Xcode asset catalog with proper file references
341+
305342
---
306343

307344
**MacSnapper** - Professional window management for macOS developers and power users.

0 commit comments

Comments
 (0)