octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2025-01-22 14:48:28 +00:00
Code Issues Releases Activity

Linked optional dependencies for generating icons

Browse Source 
It was a bit unclear that we needed those dependencies, especially if just referring to the api docs and not the main readme.
This commit is contained in:
Varun Munjeti 2016-09-12 14:52:13 +08:00 committed by GitHub
parent 9243f6689f
commit d9b3887dd1
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.md
View File

@ -132,9 +132,9 @@ The icon parameter should be a path to a `.png` file.
##### Packaging for OSX
The icon parameter can either be a `.icns` or a `.png` file if the optional dependencies listed are installed.
The icon parameter can either be a `.icns` or a `.png` file if the [optional dependencies](https://github.com/jiahaog/nativefier#optional-dependencies) are installed.
With `iconutil`, Imagemagick `convert` and `identify` optional dependencies in your `PATH`, Nativefier will automatically convert the `.png` to a `.icns` for you.
If you have the optional dependencies `iconutil`, Imagemagick `convert`, and Imagemagick `identify` in your `PATH`, Nativefier will automatically convert the `.png` to a `.icns` for you.
###### Manually Converting `.icns`