JAL-3393 improved flexibility of script and updated doc

[jalview.git] / doc / README-DMG_creation.md

diff --git a/doc/README-DMG_creation.md b/doc/README-DMG_creation.md
index 5ad5e8d..6542b7c 100644 (file)
--- a/doc/README-DMG_creation.md
+++ b/doc/README-DMG_creation.md
@@ -3,17 +3,18 @@
 ## New method to make the DS_Store file from scratch (on a Mac)
 
 ```
-./utils/install4j/mk_ds_store.sh
+./utils/install4j/mk_ds_store.sh --name Jalview [--bgimg ./utils/channels/release/image/jalview_dmg_background.png] [--output ./utils/channels/release/image/jalview_dmg_DS_Store]
 ```
 
 A script that creates a new DMG with the top level items to be found in a Jalview Installer DMG, mounts the volume, then uses an AppleScript to adjust the background image, size and position of the icons, and appearance of the Finder window.
 
 The .DS_Store is then copied out of the volume by the script, the volume unmounted, and all files (in /tmp) tidied up.
 
-To use it, the NAME (of the application, without the `.app` extension) should be set in the script (set to "Jalview"), and the background image that you want to use should be copied to your working directory as `background.png`.
+To use it, the NAME (of the application, without the `.app` extension) should be set in the script (set to "Jalview"), and the background image that you want to use should be copied to your working directory as `background.png` (or use the --bgimg option).
 
-Once it is run (only works on a Mac with osascript) it will leave a file Jalview_Installer-DS_Store in your working directory.
+Once it is run (only works on a Mac with osascript) it will leave a file Output-DS_Store in your working directory (or use the --output option).
 
+> This script borrows extensively from https://github.com/create-dmg/create-dmg
 
 ## Old manual method (possibly instructive)