tools/create-dmg/README.md

   1 create-dmg
   2 ==========
   3
   4 A shell script to build fancy DMGs.
   5
   6
   7 Status and contribution policy
   8 ------------------------------
   9
  10 This project is maintained thanks to the contributors who send pull requests. The original author has no use for the project, so his only role is reviewing and merging pull requests.
  11
  12 I will merge any pull request that adds something useful and does not break existing things.
  13
  14 Starting in January 2015, everyone who gets a pull request merged gets commit access to the repository.
  15
  16
  17 Installation
  18 ------------
  19
  20 By being a shell script, yoursway-create-dmg installation is very simple. Simply download and run.
  21
  22 > git clone https://github.com/andreyvit/yoursway-create-dmg.git
  23 > cd yoursway-create-dmg
  24 > ./create-dmg [options]
  25
  26
  27 Usage
  28 -----
  29
  30 > create-dmg [options...] [output\_name.dmg] [source\_folder]
  31
  32 All contents of source\_folder will be copied into the disk image.
  33
  34 **Options:**
  35
  36 *   **--volname [name]:** set volume name (displayed in the Finder sidebar and window title)
  37 *   **--volicon [icon.icns]:** set volume icon
  38 *   **--background [pic.png]:** set folder background image (provide png, gif, jpg)
  39 *   **--window-pos [x y]:** set position the folder window
  40 *   **--window-size [width height]:** set size of the folder window
  41 *   **--text-size [text size]:** set window text size (10-16)
  42 *   **--icon-size [icon size]:** set window icons size (up to 128)
  43 *   **--icon [file name] [x y]:** set position of the file's icon
  44 *   **--hide-extension [file name]:** hide the extension of file
  45 *   **--custom-icon [file name]/[custom icon]/[sample file] [x y]:** set position and custom icon
  46 *   **--app-drop-link [x y]:** make a drop link to Applications, at location x, y
  47 *   **--eula [eula file]:** attach a license file to the dmg
  48 *   **--no-internet-enable:** disable automatic mount&copy
  49 *   **--version:** show tool version number
  50 *   **-h, --help:** display the help
  51
  52
  53 Example
  54 -------
  55
  56 > \#!/bin/sh
  57 > test -f Application-Installer.dmg && rm Application-Installer.dmg
  58 > create-dmg \
  59 > --volname "Application Installer" \
  60 > --volicon "application\_icon.icns" \
  61 > --background "installer\_background.png" \
  62 > --window-pos 200 120 \
  63 > --window-size 800 400 \
  64 > --icon-size 100 \
  65 > --icon Application.app 200 190 \
  66 > --hide-extension Application.app \
  67 > --app-drop-link 600 185 \
  68 > Application-Installer.dmg \
  69 > source\_folder/
  70
  71
  72 Alternatives
  73 ------------
  74
  75 * [node-appdmg](https://github.com/LinusU/node-appdmg)
  76 * [dmgbuild](https://pypi.python.org/pypi/dmgbuild)
  77 * see the [StackOverflow question](http://stackoverflow.com/questions/96882/how-do-i-create-a-nice-looking-dmg-for-mac-os-x-using-command-line-tools)