# Generator [![npm](https://badge.fury.io/js/yeoman-generator.svg)](http://badge.fury.io/js/yeoman-generator) [![Build Status](https://travis-ci.org/yeoman/generator.svg?branch=master)](https://travis-ci.org/yeoman/generator) [![Coverage Status](https://coveralls.io/repos/yeoman/generator/badge.svg)](https://coveralls.io/r/yeoman/generator) [![Gitter](https://img.shields.io/badge/Gitter-Join_the_Yeoman_chat_%E2%86%92-00d06f.svg)](https://gitter.im/yeoman/yeoman) > Rails-inspired generator system that provides scaffolding for your apps ![](https://raw.githubusercontent.com/yeoman/media/master/optimized/yeoman-masthead.png) ## Getting Started If you're interested in writing your own Yeoman generator we recommend reading [the official getting started guide](http://yeoman.io/authoring/). The guide covers all the basics you need to get started. A generator can be as complex as you want it to be. It can simply copy a bunch of boilerplate files, or it can be more advanced asking the user's preferences to scaffold a tailor made project. This decision is up to you. The fastest way to get started is to use [generator-generator](https://github.com/yeoman/generator-generator), a Yeoman generator to generate a Yeoman generator. After reading the getting started guide, you might want to read the code source or visit our [API documentation](http://yeoman.io/generator/) for a list of all methods available. ### Debugging See the [debugging guide](http://yeoman.io/authoring/debugging.html). ## Contributing We love contributors! See our [contribution guideline](http://yeoman.io/contributing/) to get started. ## Sponsors Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses!
[[Become a sponsor](https://opencollective.com/yeoman#support)] ## License [BSD license](http://opensource.org/licenses/bsd-license.php) Copyright (c) Google