summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Klang <bklang@mojolingo.com>2015-08-27 11:16:30 -0400
committerBen Klang <bklang@mojolingo.com>2015-08-27 11:17:42 -0400
commit4e88508450790ed96cef1ff6df0db1e4fd3ac11d (patch)
tree7341d1d0b6d788e893ed7b944c77729c9794297e /README.md
parente097d31f6188cdd41fe4cf08ea7ee6d27576d71f (diff)
Add build instructions to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
index 29872fb8..d1c34aeb 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,38 @@ haven't spent time researching how to optimize.
I'll keep refining it over time as I learn more of AngularJS and stuff.
+Building
+--------
+zmNinja uses the [Ionic Framework](http://ionicframework.com/). To install Ionic, follow their easy [Getting Started instructions](http://ionicframework.com/getting-started/).
+
+With Ionic installed, you will need to install the build dependencies:
+
+```bash
+$ cd zmNinja # make sure you are in the directory where the project is checked out
+$ npm install
+```
+
+Next, build the application. You will need to specify the appropriate target, either `ios` or `android`:
+
+```bash
+$ ionic build ios
+# - OR -
+$ ionic build android
+```
+
+If you want to run zmNinja in an emulator, you will need to install the appropriate emulator tools.
+
+* For iOS, you will need the latest version of XCode (available in the App Store) as well as the npm package `ios-sim`: `npm install -g ios-sim`
+* For Android, you will need the latest [Android Studio](https://developer.android.com/sdk/index.html)
+
+Now, you can launch the emulator:
+
+```bash
+$ ionic emulate ios
+# - OR -
+$ ionic emulate android
+```
Screenshots: