diff options
Diffstat (limited to 'www/README.md')
| -rw-r--r-- | www/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/www/README.md b/www/README.md new file mode 100644 index 00000000..1987e13d --- /dev/null +++ b/www/README.md @@ -0,0 +1,32 @@ +This is an addon starter template for the [Ionic Framework](http://ionicframework.com/). + +## How to use this template + +*This template does not work on its own*. It is missing the Ionic library, and AngularJS. + +To use this, either create a new ionic project using the ionic node.js utility, or copy and paste this into an existing Cordova project and download a release of Ionic separately. + +### With the Ionic tool: + +Take the name after `ionic-starter-`, and that is the name of the template to be used when using the `ionic start` command below: + +```bash +$ sudo npm install -g ionic cordova +$ ionic start myApp blank +``` + +Then, to run it, cd into `myApp` and run: + +```bash +$ ionic platform add ios +$ ionic build ios +$ ionic emulate ios +``` + +Substitute ios for android if not on a Mac, but if you can, the ios development toolchain is a lot easier to work with until you need to do anything custom to Android. + +## Demo +http://plnkr.co/edit/tpl:IUU30p?p=preview + +## Issues +Issues have been disabled on this repo, if you do find an issue or have a question consider posting it on the [Ionic Forum](http://forum.ionicframework.com/). Or else if there is truly an error, follow our guidelines for [submitting an issue](http://ionicframework.com/contribute/#issues) to the main Ionic repository. On the other hand, pull requests are welcome here! |