Adds background image and Applications shortcut to macOS disk image #607
+12
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many users have reported confusion with the
Cannot create directory: /Volumes/Ricochet/config.ricochet
error they see when neglecting to drag Ricochet.app out of the disk image. See #112, #561, #510, #491, etc.Ricochet is still an amazing proof of what's possible for private, peer-to-peer chat and it's a shame that so many Mac users will hit this bug, so I got inspired and fixed it. I tested Ricochet with two friends and both experienced this issue and assumed Ricochet simply didn't work. (One friend is a junior software engineer, and the other is very technical. It seems like that this bug is preventing a lot of users from trying Ricochet!)
This PR modifies
release_osx.sh
to add a shortcut to the user's Applications folder and a background image reminding the user to drag the file, using the create-dmg script and following the default UX of electron builder. It uses a weird-and-tricky-to-create background image (this one) from the electron builder project. Electron-builder is available under an MIT license, so the use of this image should not present any problems. Mac users will see the following when they download Ricochet:My own peer-to-peer messaging project Zbay uses the same default electron-builder DMG layout as the one above, and user typically drag the app to their Applications folder. It would be possible to add branding here, but that seems like overkill.
I'm a junior developer, so apologies for the funky commit history, but it works and seems sound. I wasn't sure if this commit made sense, but it was necessary for me to get the
release_osx.sh
working locally so I figured it might be helpful to others.