From 4f8535996e495911d2908b53f02dd144d7e1668e Mon Sep 17 00:00:00 2001 From: Morgan McMillian Date: Tue, 6 Jun 2017 08:23:30 -0700 Subject: [PATCH] updated README --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2817b7..21a0f59 100644 --- a/README.md +++ b/README.md @@ -1 +1,70 @@ -## Goober +# Goober, a mobile app for pnut.io + +Copyright 2017 Morgan McMillian + +Goober is a cross platform mobile client for pnut.io built using the Ionic framework (http://ionicframework.com/). + + +## LICENSE + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + +## Core build dependencies +---- +* Install Node.js (https://nodejs.org) +* Install the latest Ionic and Cordova tools + ``` + npm install -g ionic cordova + ``` + + +## Platform build dependencies +---- + +### Android +* Install either Android Studio or the command line tools +* https://developer.android.com/studio/index.html#downloads + +### BlackBerry 10 +* Install the either the Native SDK or the WebWorks SDK +* http://developer.blackberry.com/develop/platform_choice/bb10.html + +### Windows +* Install VisualStudio +* https://www.visualstudio.com/ + + +## Other build dependencies +---- +Install required node modules +``` +cd Goober +npm install +``` + + +## Build and run + +### Browser +``` +ionic serve --lab +``` + +### Android +``` +ionic cordova platform add android # if not yet added +ionic cordova build android +ionic cordova run android +``` +