generator-vinoga

Yeoman generator for Vinoga

Getting Started with Yeoman

What is Yeoman?

Trick question. It's not a thing. It's this guy:

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 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-vinoga from npm, run:

npm install -g generator-vinoga

Yeoman Vinoga generator

This particular generator is built to help you work with the Vinoga game project. It's mainly under construction for now, but would later probably be your best friend to work on Vinoga-like projects.

First of all, ensure you've set a .yo-rc.json configuration file at the root of your project. This ensure consistency when you launch Yeoman commands.

Here is a list of available commands:

• yo vinoga displays a recap of available commands
• yo vinoga:module [moduleName] helps you create a new module

Just run commands and let Yeoman guide you in the process.

Don't hesitate to create issues if you have any feedback / requirement!

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 and Bower, check out the complete Getting Started Guide.

License

MIT