Skip to content

Commit d009886

Browse files
committed
update instruction for installation
1 parent c8c6e41 commit d009886

File tree

2 files changed

+55
-3
lines changed

2 files changed

+55
-3
lines changed

INSTALL.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Installation Guide
2+
3+
## For Users
4+
5+
### Installing from DMG
6+
1. Download the ClipboardManager DMG file
7+
2. Double-click the DMG file to mount it
8+
3. Drag the ClipboardManager app to your Applications folder
9+
4. Since the app isn't signed with an Apple Developer ID, you'll need to:
10+
- Right-click the app and select "Open" the first time
11+
- Click "Open" in the security dialog that appears
12+
- Or go to System Preferences > Security & Privacy and click "Open Anyway"
13+
14+
## For Developers
15+
16+
### Creating a Release
17+
18+
1. Archive the app in Xcode:
19+
- Select Product > Archive
20+
- Once archived, copy the app to the releases folder with appropriate version
21+
22+
2. Create DMG for distribution:
23+
```bash
24+
# Install create-dmg if not already installed
25+
brew install create-dmg
26+
27+
# Create DMG file
28+
create-dmg \
29+
--volname "ClipboardManager" \
30+
--window-pos 200 120 \
31+
--window-size 800 400 \
32+
--icon-size 100 \
33+
--icon "ClipboardManager.app" 200 190 \
34+
--app-drop-link 600 185 \
35+
"ClipboardManager-[VERSION].dmg" \
36+
"releases/ClipboardManager.v.[VERSION]/ClipboardManager.app"
37+
```
38+
Replace [VERSION] with the actual version number (e.g., 1.2)
39+
40+
### Notes
41+
- The DMG creation process will automatically:
42+
- Create a window with custom positioning
43+
- Add an Applications folder shortcut for easy installation
44+
- Set appropriate icon sizes and positions
45+
- Compress the final DMG file
46+
47+
### Future Improvements
48+
- Code signing with Apple Developer ID
49+
- Notarization for improved security
50+
- Automatic update mechanism

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,14 @@ The application is built with a hybrid architecture:
5353
- macOS 12.0 or later
5454
- [Download the latest release](https://github.com/yourusername/clipboard-manager/releases)
5555

56-
### Setup
57-
1. Download and extract the latest release
58-
2. Move ClipboardManager.app to your Applications folder
56+
### Quick Setup
57+
1. Download and mount the DMG file
58+
2. Drag ClipboardManager.app to your Applications folder
5959
3. Launch the app - it will appear in your menu bar
6060
4. Grant necessary permissions when prompted
6161

62+
For detailed installation instructions and developer guide for creating releases, see [INSTALL.md](INSTALL.md).
63+
6264
## Development
6365

6466
### Prerequisites

0 commit comments

Comments
 (0)