From d9b3887dd11fb4cf9ca4e53884319fde34073570 Mon Sep 17 00:00:00 2001 From: Varun Munjeti Date: Mon, 12 Sep 2016 14:52:13 +0800 Subject: [PATCH 1/2] Linked optional dependencies for generating icons It was a bit unclear that we needed those dependencies, especially if just referring to the api docs and not the main readme. --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index a7d6c5a..409dd58 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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` From ac317a88ac54e4e51924bd6760e5c9955bcd4f4e Mon Sep 17 00:00:00 2001 From: Goh Jia Hao Date: Sun, 9 Oct 2016 14:20:28 +0800 Subject: [PATCH 2/2] Use relative link --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 5007c37..8f9f8dd 100644 --- a/docs/api.md +++ b/docs/api.md @@ -133,7 +133,7 @@ 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](https://github.com/jiahaog/nativefier#optional-dependencies) are installed. +The icon parameter can either be a `.icns` or a `.png` file if the [optional dependencies](../README.md#optional-dependencies) are installed. 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.