Skip to content

Commit 5cfe39e

Browse files
committed
Readme tweaks
1 parent 7d684a2 commit 5cfe39e

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

readme.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,8 @@ Imagine you have finished a macOS app, exported it from Xcode, and now want to d
66

77
<img src="screenshot-cli.gif" width="998">
88

9-
Discuss it on [Product Hunt](https://www.producthunt.com/posts/create-dmg) and [Twitter](https://twitter.com/sindresorhus/status/846416556754010112).
10-
119
*This tool is intentionally opinionated and simple. I'm not interested in adding lots of options.*
1210

13-
You might also find my [`LaunchAtLogin`](https://github.com/sindresorhus/LaunchAtLogin) project useful.
14-
15-
1611
## Install
1712

1813
Ensure you have [Node.js](https://nodejs.org) 8 or later installed. Then run the following:
@@ -21,7 +16,6 @@ Ensure you have [Node.js](https://nodejs.org) 8 or later installed. Then run the
2116
$ npm install --global create-dmg
2217
```
2318

24-
2519
## Usage
2620

2721
```
@@ -31,16 +25,15 @@ $ create-dmg --help
3125
$ create-dmg <app> [destination]
3226
3327
Options
34-
--overwrite Overwrite existing DMG with the same name
35-
--identity=<value> Manually set code signing identity (automatic by default)
28+
--overwrite Overwrite existing DMG with the same name
29+
--identity=<value> Manually set code signing identity (automatic by default)
3630
--dmg-title=<value> Manually set title of DMG volume (only used if app name is >27 character limit)
3731
3832
Examples
3933
$ create-dmg 'Lungo.app'
4034
$ create-dmg 'Lungo.app' Build/Releases
4135
```
4236

43-
4437
## DMG
4538

4639
The DMG detects the minimum runtime of the app, and uses ULFO (macOS 10.11 or later) or UDZO as appropriate. The resulting image has the filename `App Name 0.0.0.dmg`, for example `Lungo 1.0.0.dmg`.
@@ -49,13 +42,13 @@ It will try to code sign the DMG, but the DMG is still created and fine even if
4942

5043
<img src="screenshot-dmg.png" width="772">
5144

52-
### Software license
45+
### Software license agreement
5346

54-
If `license.txt`, `license.rtf`, or `sla.r` ([raw SLAResources file](https://download.developer.apple.com/Developer_Tools/software_licensing_for_udif/slas_for_udifs_1.0.dmg)) are present in the same folder as the app, they will be added as a software agreement when opening the image. The image will not be mounted unless the user indicates agreement with the license.
47+
If either `license.txt`, `license.rtf`, or `sla.r` ([raw SLAResources file](https://download.developer.apple.com/Developer_Tools/software_licensing_for_udif/slas_for_udifs_1.0.dmg)) are present in the same directory as the app, it will be added as a software agreement when opening the image. The image will not be mounted unless the user indicates agreement with the license.
5548

56-
`/usr/bin/rez` [Command Line Tools for Xcode](https://developer.apple.com/download/more/) must be installed.
49+
`/usr/bin/rez` (from [Command Line Tools for Xcode](https://developer.apple.com/download/more/)) must be installed.
5750

58-
### DMG Icon
51+
### DMG icon
5952

6053
[GraphicsMagick](http://www.graphicsmagick.org) is required to create the custom DMG icon that's based on the app icon and the macOS mounted device icon.
6154

@@ -65,8 +58,19 @@ If `license.txt`, `license.rtf`, or `sla.r` ([raw SLAResources file](https://dow
6558
$ brew install graphicsmagick imagemagick
6659
```
6760

68-
#### Icon Example
61+
#### Icon example
6962

7063
Original icon → DMG icon
7164

7265
<img src="icon-example-app.png" width="300"><img src="icon-example.png" width="300">
66+
67+
## Links
68+
69+
- [Product Hunt post](https://www.producthunt.com/posts/create-dmg)
70+
71+
## Related
72+
73+
- [Defaults](https://github.com/sindresorhus/Defaults) - Swifty and modern UserDefaults
74+
- [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) - Add “Launch at Login” functionality to your macOS
75+
- [Preferences](https://github.com/sindresorhus/Preferences) - Add a preferences window to your macOS app
76+
- [More…](https://github.com/search?q=user%3Asindresorhus+language%3Aswift)

0 commit comments

Comments
 (0)