Commit 8a770fe8 authored by Philipp Nowinski's avatar Philipp Nowinski
Browse files

[TASK] update readme

parent 31f0ff78
# generator-sgalinski [![Build Status](https://secure.travis-ci.org/someuser/generator-sgalinski.png?branch=master)](https://travis-ci.org/someuser/generator-sgalinski)
# generator-sgalinski
> [Yeoman](http://yeoman.io) generator
## Installation
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
![](http://i.imgur.com/JHaAlBJ.png)
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.*
To use the sgalinski-generator you need to have node and npm installed. Furthermore, you should have
yeoman, gulp and bower installed globally. To do so, simply run
```bash
npm install -g yo
npm install -g bower
npm install -g gulp
```
### 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-sgalinski from npm, run:
Since this generator is not published to the npm registry, you need to clone this repo an run
```bash
npm install -g generator-sgalinski
npm link
```
Finally, initiate the generator:
to be able to use it. This will create a symlink to the 'generator-sgalinski' directory.
## Usage
To run the generator, navigate to the directory you want to create your project in and run
```bash
yo sgalinski
```
### 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).
## License
MIT
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment