JAL-3594 New Jalview Test logos and .icns/.ico creation helper script

[jalview.git] / doc / README_convert_PNG_to_ICNS_and_ICO

diff --git a/utils/install4j/README_convert_PNG_to_ICNS_and_ICO b/doc/README_convert_PNG_to_ICNS_and_ICO
similarity index 64%
rename from utils/install4j/README_convert_PNG_to_ICNS_and_ICO
rename to doc/README_convert_PNG_to_ICNS_and_ICO
index 393754e..11892e0 100644 (file)
--- a/utils/install4j/README_convert_PNG_to_ICNS_and_ICO
+++ b/doc/README_convert_PNG_to_ICNS_and_ICO
@@ -1,4 +1,23 @@
-## Creating the .ico (Windows) and .icns (macOS) files from PNG images in linux
+## There is now a script utils/mk_jalview_icons.sh that creates the .icns and .ico icon files, and also the rotatable icon.
+Run it as
+```
+mk_jalview_icons.sh <BASENAME>-512.png
+```
+Having an existing 512x512 PNG image with the above filename format is important.
+It will then create multiple files
+`<BASENAME>-<N>.png`
+for N being 16, 32, 38, 48, 64, 128, 256.
+**NB** You might want to edit these as described below.  The `mk_jalview_icons.sh` will not overwrite these files, but it
+will overwrite the `.ico` and `.icns` files, so after editing the `<BASENAME>-<N>.png` files, just run the script again.
+
+As below, the script relies on ImageMagick and icnsutils being installed with `convert` and `png2icns` in the PATH.
+
+The rotatable logo will also be created (and overwritten) as
+`rotatable_<BASENAME>-38.png`
+
+
+## Old text
+### Creating the .ico (Windows) and .icns (macOS) files from PNG images in linux
 
 Create multiple square versions of your icon at the following resolutions:
 16x16, 32x32, 48x48, 64x64, 128x128, 256x256, 512x512