cordova-icon-cli
v0.3.6
Published
Automatic icon resizing for Cordova
Downloads
8
Readme
cordova-icon
Automatic icon resizing for Cordova. Create an icon in the root folder of your Cordova project and use cordova-icon to automatically resize and copy it for all the platforms your project supports (currenty works with iOS and Android).
Installation
$ sudo npm install cordova-icon-cli -g
Usage
Create an icon.png
file in the root folder of your cordova project and run:
$ cordova-icon
To specify a custom splash image or config file use it like this:
$ cordova-icon --icon path/to/icon --config /path/to/config
For optimal results, your file has to be square, and at least 180*180px. To be future-proof, since the generated file dimensions are going to evolve, you should probably use 512*512px or 1024*1024px.
Creating a cordova-cli hook
Since the execution of cordova-icon is pretty fast, you can add it as a cordova-cli hook to execute before every build. To create a new hook, go to your cordova project and run:
$ mkdir hooks/after_prepare
$ vi hooks/after_prepare/cordova-icon.sh
Paste the following into the hook script:
#!/bin/bash
cordova-icon
Then give the script +x permission:
$ chmod +x hooks/after_prepare/cordova-icon.sh
That's it. Now every time you cordova build
, the icons will be auto generated.
Requirements
- ImageMagick
Install on a Mac:
$ brew install imagemagick
On windows see http://www.imagemagick.org/script/binary-releases.php#windows
- At least one platform was added to your project (cordova platforms docs)
- Cordova's config.xml file must exist in the root folder (cordova config.xml docs)
Splash screens
check out cordova-splash
License
MIT