diff --git a/Assets/Images/dmg_background.png b/Assets/Images/dmg_background.png new file mode 100644 index 0000000000000000000000000000000000000000..a3c2addd20619860e7d9cbb9c122be9d7f0e2a28 --- /dev/null +++ b/Assets/Images/dmg_background.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64b118282c69e2c9da52fe9c52574c24e3ad97236e17bda329780c6c44bcb674 +size 4080 diff --git a/DEPLOY.md b/DEPLOY.md index f193c22d6a999b88172778166046c580cacfcbf1..50f190834ac5d96916f37cd12f332518acaf7053 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -26,7 +26,8 @@ at the same time with the *same* version number. ### Archive type -- For Linux and macOS, deploy `.tar.gz` files (-> smallest file size as compared to `.zip` and `.tar`). +- For Linux, deploy `.tar.gz` files (-> smallest file size as compared to `.zip` and `.tar`) +- For macOS, deploy `.dmg` files - For Windows, deploy `.zip` files (-> guaranteed compatibility among end users since Windows Explorer can open them) ### Building Binaries (MultiBuild.bat can be used to do this automatically. MultiBuild.sh is maybe outdated and needs adjustments) @@ -45,11 +46,11 @@ at the same time with the *same* version number. ### Building Archives - For Windows: zip -r \<TARGET-DIR\>/UFrameIT-\<version\>-Windows.zip \<SOURCE-DIR\> - For Linux: tar -zcvf UFrameIT-\<version\>-Linux.tar.gz \<SOURCE-DIR\> -- For macOS: 1) Create a dmg-file from the .app-file (Only possible on macOS) 2) Build a tgz-file from that dmg +- For macOS: Create a dmg-file from the .app-file (Only possible on macOS) - mkdir UFrameIT-Image-Folder - cp \<UFrameIT-.app-file\> UFrameIT-Image-Folder/\<UFrameIT-.app-file\> - - hdiutil create UFrameIT-Image.dmg -volname "UFrameIT Image" -srcfolder UFrameIT-Image-Folder - - tar -zcvf UFrameIT-\<version\>-Mac.tar.gz \<SOURCE-DIR\> + - hdiutil create UFrameIT-\<version\>-Mac.dmg -volname "UFrameIT-\<version\>" -srcfolder UFrameIT-Image-Folder + - For adjusting the appearance of the dmg, the image from "Assets/Images/dmg_background.png" can be used ### Hints for deployment - The build for macOS usually only works if it's built from a Mac diff --git a/MultiBuild.bat b/MultiBuild.bat index 0e34136e3118a252508ef90b535594d11bc99108..6356773c509ff4c19d1a159749bdcfeed7b509e6 100644 --- a/MultiBuild.bat +++ b/MultiBuild.bat @@ -33,5 +33,4 @@ start "Windows-zip" /D "%projectPath%" /W zip -r UFrameIT-Windows.zip Build echo Creating Linux tgz-file... start "Linux-tgz" /D "%projectPath%" /W tar -zcvf UFrameIT-Linux.tar.gz Linux -echo Creating Mac tgz-file... (Please use macOS to create a dmg-file from the .app-file, see DEPLOY.md) -start "Mac-tgz" /D "%projectPath%" /W tar -zcvf UFrameIT-Mac.tar.gz FrameWorld.app \ No newline at end of file +set /p=Please use macOS to create a dmg-file from the .app-file, see DEPLOY.md. Hit ENTER to exit... \ No newline at end of file