Table of contents

• Status
• Prerequisites
• App icons and loading screens
• Install
• Setup
• Usage

Status

Prerequisites

Please install

• Node >= 6.0.0 and NPM >= 5.0.0

• Android Studio (for Android development)

• Xcode (for iOS development)

• Imagemagick for icon processing

$ sudo apt-get install imagemagick
$ # on Mac: brew install imagemagick
$ # on Windows: http://www.imagemagick.org/script/binary-releases.php#windows (check "Legacy tools")

App icons and loading screens

• cordova-runner uses the convenient cordova-icon and cordova-splash packages for icon and loading (splash) screen processing.

App icon

• Your app icon must be a .png file
• You must name it icon.png
• It should be square and ideally 512x512px, but no smaller than 192x192px

Loading screen

• Your app icon must be a .png file

• You must name it splash.png

• It should be 2208x2208 px with a center square of about 1200x1200 px.

• Please copy your icon.png and splash.png to the root of your project before using cordova-runner.

Install

$ npm install -g cordova-runner

Setup

• cd into your html/css/js project.

  • A generic project structure might look something like this:

  .
  ├── css
  │   ├── style.css
  │   └── theme.css
  ├── img
  │   └── image.png
  ├── js
  │   ├── custom.js
  │   └── theme.js
  ├── about.html
  ├── contact.html
  ├── icon.png
  ├── index.html
  └── splash.png
  

  • Note: Your root html must be called index.html. Please rename your root html file if you have to.

Usage:

1. Run in your terminal:

$ cordova-runner

2. After that, just follow the prompt.