aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMAddAppIcon.cmake
diff options
context:
space:
mode:
authorR.J.V. Bertin <rjvbertin@gmail.com>2017-01-10 12:26:17 +0100
committerR.J.V. Bertin <rjvbertin@gmail.com>2017-01-10 12:26:17 +0100
commit0b4f9d5fd47956b1cb432056330dd6917789c367 (patch)
tree06ce7c5c6d809c75d26af480c60a754d504693b8 /modules/ECMAddAppIcon.cmake
parent51b7b494213643c9808efecf6a7372d3b63c6f50 (diff)
downloadextra-cmake-modules-0b4f9d5fd47956b1cb432056330dd6917789c367.tar.gz
extra-cmake-modules-0b4f9d5fd47956b1cb432056330dd6917789c367.tar.bz2
Update the ecm_add_app_icon documentation
Inform the user that SVG icons can now be provided in the macro call; on Mac the first that converts to .icns (if ksvg2icns is available) will provide the application icon. Other SVG files are ignored, idem on other platforms.
Diffstat (limited to 'modules/ECMAddAppIcon.cmake')
-rw-r--r--modules/ECMAddAppIcon.cmake13
1 files changed, 9 insertions, 4 deletions
diff --git a/modules/ECMAddAppIcon.cmake b/modules/ECMAddAppIcon.cmake
index 7207c66e..e7adc405 100644
--- a/modules/ECMAddAppIcon.cmake
+++ b/modules/ECMAddAppIcon.cmake
@@ -15,6 +15,8 @@
#
# will be added to the executable target whose sources are specified by
# ``<sources_var>`` on platforms that support it (Windows and Mac OS X).
+# Other icon files are ignored but on Mac SVG files can be supported and
+# it is thus possible to mix those with png files in a single macro call.
#
# ``<size>`` is a numeric pixel size (typically 16, 32, 48, 64, 128 or 256).
# ``<other_text>`` can be any other text. See the platform notes below for any
@@ -30,14 +32,17 @@
# Mac OS X notes
# * The executable target must have the ``MACOSX_BUNDLE`` property set.
# * Icons are added to the bundle.
-# * The tool iconutil (provided by Apple) is required.
-# * Supported sizes: 16, 32, 64, 128, 256, 512, 1024.
-# * At least a 128x128px icon is required.
+# * If the ksvg2icns tool from KIconThemes is available, .svg and .svgz
+# files are accepted; the first that is converted successfully to .icns
+# will provide the application icon. SVG files are ignored otherwise.
+# * The tool iconutil (provided by Apple) is required for bitmap icons.
+# * Supported sizes: 16, 32, 64, 128, 256 (and 512, 1024 after OS X 10.9).
+# * At least a 128x128px (or an SVG) icon is required.
# * Larger sizes are automatically used to substitute for smaller sizes on
# "Retina" (high-resolution) displays. For example, a 32px icon, if
# provided, will be used as a 32px icon on standard-resolution displays,
# and as a 16px-equivalent icon (with an "@2x" tag) on high-resolution
-# displays.
+# displays. ksvg2icns handles this internally.
# * This function sets the ``MACOSX_BUNDLE_ICON_FILE`` variable to the name
# of the generated icns file, so that it will be used as the
# ``MACOSX_BUNDLE_ICON_FILE`` target property when you call