# ShopIgniter 4.x Theme Generator
> [Yeoman](http://yeoman.io) generator

## Getting Started

### Install Yeoman

Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*

```
$ npm install -g yo
```

### Usage

To install generator-igniter4 from npm, run:

```
$ npm install -g generator-igniter4
```

Finally, initiate the generator:

```
$ yo igniter4
```

The generator will scaffold out a complete theme for you based on the original Theme Boilerplate.  

### Features

* Custom prompt asking for the Theme Name that is used to customize the following app files:

| File          | Description |
| ------------- | ------------- |
| bower.json    | Sends in a slugified version of the theme name into the bower package name field.  |
| package.json  | Does the same thing as bower.json but for package.json |
| Gruntfile.js  | Yeoman-defined 'app' and 'dist' variables are used to populate the Gruntfile to point to the correct directories. |
| README.md     | Heading uses the capitalized version of the Theme Name |
| theme.yml     | theme_name uses the capitalized version of the Theme Name |
|               | theme_slug uses the slugified version of the Theme Name |
|               | theme_tags uses the slugified version of the Theme Name |

* Direct copy of IgniterPromotionBundle/ and public/ assets
* Allows for convenient on-the-fly theme creation and updating by simply running the 'yo igniter4' command with conflict resolution built-in, so there's no need to worry about overwriting files when running the generator again to pull in an update.