octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-11-05 04:47:54 +00:00
Code Issues Releases Activity

Make documentation for optional dependencies clearer in API docs for icon (#258)

Browse Source 
Merge branch 'vrunjeti-patch-1' into development
This commit is contained in:
Goh Jia Hao 2016-10-09 14:21:35 +08:00
commit c660f2a79a
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

@ -133,9 +133,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](../README.md#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`