Skip to content

Commit

Permalink
Merge pull request diegonetto#152 from SidneyS/master
Browse files Browse the repository at this point in the history
chore(generator): Merged fixes and improvements from all active forks.
  • Loading branch information
diegonetto committed Feb 5, 2015
2 parents 8bd7eea + 2249151 commit 97a3938
Show file tree
Hide file tree
Showing 18 changed files with 869 additions and 457 deletions.
59 changes: 0 additions & 59 deletions Gruntfile.js

This file was deleted.

44 changes: 11 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<p align="center">
<a href="http://blacklitelabs.com/">
<img width="341" height="308" src="http://i.imgur.com/BGrt2QK.png"/>
</a>
</p>
![](http://i.imgur.com/BGrt2QK.png)

## Ionic Framework generator [![Build Status][travis-image]][travis-url] [![NPM version][npm-image]][npm-url]
## Ionic Framework generator [![Build Status](https://api.travis-ci.org/JaKXz/generator-ionic.png?branch=master)](https://travis-ci.org/JaKXz/generator-ionic) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) [![Code Climate](https://codeclimate.com/github/JaKXz/generator-ionic/badges/gpa.svg)](https://codeclimate.com/github/JaKXz/generator-ionic)

**Note**: To run my version of the generator, you'll have to uninstall the original version and clone this repository and run `npm link`.

> Yeoman generator for creating Ionic hybrid mobile applications using AngularJS and Cordova - lets you quickly set up a project with sensible defaults and best practices.
Expand All @@ -26,10 +24,10 @@
- Bundled [ripple emulator](http://ripple.incubator.apache.org/)

## Usage
Install `generator-ionic`
<!--Install `generator-ionic`
```
npm install -g generator-ionic
```
```-->

Make a new directory, and `cd` into it
```
Expand All @@ -44,7 +42,7 @@ yo ionic [app-name]
Run `grunt` for building / compressing your Ionic app, `grunt serve` for a browser preview, and `grunt serve:compress` for a preview of the optimized application.

## Upgrading
Make sure you've commited (or backed up) your local changes and install the latest version of the generator via `npm install -g generator-ionic`, then go ahead and re-run `yo ionic` inside your project's directory.
Make sure you've committed (or backed up) your local changes and install the latest version of the generator via `npm install -g generator-ionic`, then go ahead and re-run `yo ionic` inside your project's directory.

The handsome devil is smart enough to figure out what files he is attempting to overwrite and prompts you to choose how you would like to proceed. Select `Y` for overwriting your `Gruntfile.js` and `bower.json` to stay up-to-date with the latest workflow goodies and front-end packages.

Expand Down Expand Up @@ -73,8 +71,7 @@ Overview
├── coverage/ - Istanbul reports
├── test/ - Unit tests
│ ├── spec/
├── www/ - Copied from app/ to be used by Cordova

├── www/ - Copied from app/ to be used by Cordova

## Workflow Commands

Expand Down Expand Up @@ -108,7 +105,7 @@ Either `emulate` your Ionic app inside a simulator or `run` it on a connected de
$ grunt emulate:ios --lc
$ grunt emulate:ios --target=iPad -lc
$ grunt emulate:android --consolelogs

$ grunt run:ios
$ grunt run:android

Expand Down Expand Up @@ -147,28 +144,9 @@ Launch the bundled [Ripple](http://ripple.incubator.apache.org/) emulator by fir

For a Getting Started guide, FAQ, and helpful tips, please see the [documentation](docs/README.md).

## Contribute

See the [contributing docs](https://github.com/diegonetto/generator-ionic/blob/master/contributing.md).

When submitting an issue, please follow the [guidelines](https://github.com/diegonetto/generator-ionic/blob/master/contributing.md#issue-submission). Especially important is to make sure `generator-ionic` is up-to-date, and providing the command or commands that cause the issue.


When submitting a PR, make sure that the commit messages match the [AngularJS conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/).

When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

When submitting a new feature, add tests that cover the feature.

For testing & debugging the generator please refer to the Yeoman Generator [testing documentation](https://github.com/yeoman/generator/wiki/Testing-generators).

## License

[MIT License](http://opensource.org/licenses/mit-license.php)

[travis-image]: http://img.shields.io/travis/diegonetto/generator-ionic.svg?style=flat
[travis-url]: https://travis-ci.org/diegonetto/generator-ionic
[npm-url]: https://npmjs.org/package/generator-ionic
[npm-image]: http://img.shields.io/npm/v/generator-ionic.svg?style=flat
[gittip-image]: http://img.shields.io/gittip/diegonetto.svg?style=flat
[gittip-url]: https://www.gittip.com/diegonetto
[travis-image]: http://img.shields.io/travis/JaKXz/generator-ionic.svg?style=flat
[travis-url]: https://travis-ci.org/JaKXz/generator-ionic
Loading

0 comments on commit 97a3938

Please sign in to comment.