generator-express-static/README.md

A generator for Yeoman used to create an Expressjs static site generator.

# generator-express-static [![Build Status](https://secure.travis-ci.org/jacobheun/generator-express-static.png?branch=master)](https://travis-ci.org/jacobheun/generator-express-static)

A generator for [Yeoman](http://yeoman.io).


## Getting Started

### What is Yeoman?

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

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
```

### Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-express-static from npm, run:

```
$ npm install -g generator-express-static
```

Finally, initiate the generator:

```
$ yo express-static
```

### Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).

## Developing

You can test this generator out locally by cloning the repo and then linking with npm:

```
$ npm link
```

Then just initiate the generator in the directory of your choosing.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)