create-dmg/readme.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2017-03-27 21:09:27 +07:00
# create-dmg [![Build Status](https://travis-ci.org/sindresorhus/create-dmg.svg?branch=master)](https://travis-ci.org/sindresorhus/create-dmg)
2017-03-31 19:46:41 +07:00
> Create a good-looking [DMG](https://en.m.wikipedia.org/wiki/Apple_Disk_Image) for your macOS app in seconds
2017-03-27 21:09:27 +07:00
2017-03-31 19:46:41 +07:00
<img src="screenshot-cli.gif" width="998">
**Discuss it on [Product Hunt](https://www.producthunt.com/posts/create-dmg) and [Twitter](https://twitter.com/sindresorhus/status/846416556754010112).**
2017-03-27 21:09:27 +07:00
*This tool is intentionally opinionated and simple. I'm not interested in adding lots of options.*
## Install
2017-03-31 20:59:29 +07:00
Ensure you have [Node.js](https://nodejs.org) 4 or later installed. Then run the following:
2017-03-27 21:09:27 +07:00
```
$ npm install --global create-dmg
```
## Usage
```
$ create-dmg --help
Usage
$ create-dmg <app>
Example
$ create-dmg 'Lungo.app'
```
## DMG
The DMG requires macOS 10.11 or later and has the filename `appName-appVersion.dmg`, for example `Lungo-1.0.0.dmg`.
It will try to code sign the DMG, but the DMG is still created and fine even if the code signing fails, for example if you don't have a developer certificate.
2017-03-27 21:09:27 +07:00
<img src="screenshot-dmg.png" width="772">
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)