Include Mac install instructions in package root

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@4388 ab8295b8-cf94-4d9e-aec4-7959e3be5d79

CMakeCPackOptions.cmake.in

@@ -54,7 +54,7 @@ endif ()
 
 if ("${CPACK_GENERATOR}" STREQUAL "DragNDrop")
   set (CPACK_DMG_BACKGROUND_IMAGE "@PROJECT_SOURCE_DIR@/icons/Darwin/DragNDrop Background.png")
-  set (CPACK_DMG_DS_STORE "@PROJECT_SOURCE_DIR@/wsjtx_DMG.DS_Store")
+  set (CPACK_DMG_DS_STORE "@PROJECT_SOURCE_DIR@/Darwin/wsjtx_DMG.DS_Store")
   set (CPACK_BUNDLE_NAME "@WSJTX_BUNDLE_NAME@")
   set (CPACK_PACKAGE_ICON "@PROJECT_BINARY_DIR@/wsjtx.icns")
   set (CPACK_BUNDLE_ICON "@PROJECT_BINARY_DIR@/wsjtx.icns")

CMakeLists.txt

@@ -738,6 +738,18 @@ install (FILES
   #COMPONENT Runtime
   )
 
+#
+# Mac installer files
+#
+if (APPLE)
+    install (FILES
+        Darwin/ReadMe.txt
+        Darwin/sysctl.conf
+        DESTINATION .
+        #COMPONENT Runtime
+    )
+endif (APPLE)
+
 
 #
 # uninstall support
@@ -939,7 +951,7 @@ endif (WSJTX_RC)
 if (WIN32)
   set (CPACK_GENERATOR "NSIS")
 elseif (APPLE)
-  set (CPACK_GENERATOR "DragNDrop" "PackageMaker")
+  set (CPACK_GENERATOR "DragNDrop")
 else ()
   #
   # Derive the correct filename for a Debian package because the DEB

Darwin/ReadMe.txt

@@ -0,0 +1,95 @@
+                          Notes on WSJT-X Installation for Mac OS X
+                          -----------------------------------------
+
+If you have already downloaded a previous version of WSJT-X then I suggest 
+you change the name in the Applications folder from WSJT-X to WSJT-X_previous 
+before proceeding.  
+
+If you have installed a previous version of WSJT-X before then there is no 
+need to change anything on your system so proceed to NEXT.  
+
+BEGIN:
+
+There are some system matters you must deal with first.  Open a Terminal window
+by going to Applications->Utilities and clicking on Terminal.
+
+Along with this ReadMe file there is a file:   sysctl.conf.   Drag this file to your Desktop.
+Then type in the Terminal window:
+
+   cd $HOME/Desktop
+
+WSJT-X makes use of a block of memory which is shared between different parts of
+the code.  The normal allocation of shared memory on a Mac is insufficient and this 
+has to be increased.   You can look at the new allocation by typing:
+
+   cat  sysctl.conf
+
+This shows the following:
+
+kern.sysv.shmmax=33554432
+kern.sysv.shmmin=1
+kern.sysv.shmmni=128
+kern.sysv.shmseg=32
+kern.sysv.shmall=8192
+
+You can check the current allocation on your Mac by typing:
+
+  sysctl -a | grep sysv.shm
+
+If your shmmax is already at least 33554432 (32 MB) then you can close the Terminal window
+and skip the next steps and go to (NEXT).
+
+Now move this file into place for the system to use by typing:
+
+  sudo mv sysctl.conf /etc/
+
+and then reboot your Mac.  This is necessary to install the changes.  After the
+reboot you should re-open the Terminal window as before and you can check that the
+change has been made by typing:
+
+  sysctl -a | grep sysv.shm
+
+You are finished with system changes.  You should make certain that NO error messages
+have been produced during these steps.   You can now close the Terminal window.  It will
+not be necessary to repeat this procedure again, even when you download an updated
+version of WSJT-X.
+
+NEXT:
+
+Drag the WSJT-X app to your preferred location, such as Applications.
+
+You need to configure your sound card.   Visit Applications > Utilities > Audio MIDI Setup  and
+select your sound card and then set Format to be "48000Hz 2ch-16bit" for input and output.
+
+Now double-click on the WSJT-X app and two windows will appear.  Select Preferences under the 
+WSJT-X Menu and fill in various station details on the General panel.   I recommend checking the
+4 boxes under the Display heading and the first 4 boxes under the Behaviour heading.
+
+Next visit the Audio panel and select the Audio Codec you use to communicate between WSJT-X
+and your rig.   There are so many audio interfaces available that it is not possible to give
+detailed advice on selection.  If you have difficulties contact me.   Note the location of the
+Save Directory.  Decoded wave forms are located here.
+
+Look at the Reporting panel.  If you check the "Prompt me" box, a logging panel will appear
+at the end of the QSO.  Two log files are provided in  Library/Application Support/WSJT-X.
+These are a simple wsjtx.log file and wsjtx_log.adi which is formatted for use with logging
+databases.
+
+Finally, visit the Radio panel.  WSJT-X is most effective when operated with CAT control.  You 
+will need to install the relevant Mac driver for your rig.   This must be located in the system
+driver directory  /dev.  I use a Prolific USB-Serial Adapter to a Kenwood TS870s and the relevant
+driver is  /dev/tty.PL2303-00002226.   You should install your driver and then re-launch WSJT-X.
+Return to the the Radio panel in Preferences and insert the full name of your driver in the
+Serial Port panel.   Such as:  /dev/tty.PL2303-00002226 or what ever driver you have.  The /dev/
+prefix is mandatory.  Set the relevant communication parameters as required by your transceiver.
+
+WSJT-X needs the Mac clock to be accurate.  Visit System Preferences > Date & Time and make sure that
+date and time are set automatically.   The drop-down menu will normally offer you several time
+servers to choose from.
+
+On the Help menu, have a look at the new Online User's Guide for operational hints and tips.
+
+Please email me if you have problems.
+
+--- John G4KLA     (g4kla@rmnjmn.demon.co.uk)
+

Darwin/developer read me.txt

@@ -0,0 +1,63 @@
+Changing the content of the DragNDrop DMG root folder.
+======================================================
+
+The files and links in this folder are populated by the WSJT-X CMake build script. There are install commands which are only run on Apple hosts, this is important becuase they will get installed at the install root on other platforms, which would be very bad on Linux for example since that is /usr normally!
+
+The symlink to /Applications, the background image (derived from "~/src/wsjtx/artwork/DragNDrop Background.svg") and, the custom .DS_Store file ("~/src/wsjtx_DMG.DS_Store") are all handled specifically by the CPack DragNDrop packager so you don't need to install those.
+
+
+
+Modifying the .DS_Store folder options for the DragNDrop DMG root folder.
+=========================================================================
+
+The DragNDrop installer is a generated a DMG file that has a custom .DS_Store file that defines the layout, background image and, folder view options of the DMG root folder.
+
+To modify this file, first you need to make a DragNDrop package then mount the DMG file, then modify the root .DS_Store file using Finder. Once you are happy with the results, you check into source control the modified .DS_Store file and then future package builds will use that file.
+
+The installer DMG is read only and shrunk to exactly the size of the contents, also the .DS_Store file is read only and the background image PNG file is hidden. You need to undo all of these things before changing the .DS_Store file. Don't forget to redo these things before checking in a new version of the custom .DS_Store file.
+
+# convert the DMG to a R/W copy
+hdiutil convert wsjtx-1.4.0-rc1-Darwin.dmg -format UDRW -o rw.dmg
+
+# expand the R/W copy to make room for changes
+# first find the current number of sectors
+hdiutil resize -limits rw.dmg
+# the output looks like:
+#
+#  min 	 cur 	 max
+#109696	109696	33037872
+#
+# you need to increase the sector count to something a bit bigger than current
+#  e.g. in this case use 110000
+hdiutil resize -sectors 110000 rw.dmg
+
+# now you can mount the R/W DMG
+hdiutil attach rw.dmg
+
+# change the hidden attribute on the background PNG
+chflags nohidden /Volumes/wsjtx-1.4.0-rc1-Darwin/background.png
+
+# make the .DS_Store file writeable
+chmod 644 /Volumes/wsjtx-1.4.0-rc1-Darwin/.DS_Store
+
+# now you can change Finder view options, rearrange icons etc. Remember that you are only changing the folder options, not the folder content as that is controlled by the install steps in the project CMakeLists.txt
+# if you are adding or removing a file to the DMG root folder, you need to have changed the install steps before doing this procedure so the content changes are reflected in the installer DMG you start with
+
+# when you are happy with the layout etc.
+# set the background PNG as a hidden file
+chflags hidden /Volumes/wsjtx-1.4.0-rc1-Darwin/background.png
+
+# make the .DS_Store file read only
+chmod 444 /Volumes/wsjtx-1.4.0-rc1-Darwin/.DS_Store
+
+# update the custom .DS_Store file in the source repository (NOTE the file name)
+cp /Volumes/wsjtx-1.4.0-rc1-Darwin/.DS_Store ~/src/wsjtx/wsjtx_DMG.DS_Store
+
+# build a new package and try out the new installer to test your changes
+# if all is well commit the changes
+
+# dismount and eject the R/W DMG and discard it
+hdiutil detach /Volumes/wsjtx-1.4.0-rc1-Darwin
+rm rw.dmg
+
+# That's all Folks!

Darwin/sysctl.conf

@@ -0,0 +1,6 @@
+kern.sysv.shmmax=33554432
+kern.sysv.shmmin=1
+kern.sysv.shmmni=128
+kern.sysv.shmseg=32
+kern.sysv.shmall=8192
+