| 1 | # Generator [](http://badge.fury.io/js/yeoman-generator) [](https://travis-ci.org/yeoman/generator) [](https://coveralls.io/r/yeoman/generator) [](https://gitter.im/yeoman/yeoman)
|
| 2 |
|
| 3 | > Rails-inspired generator system that provides scaffolding for your apps
|
| 4 |
|
| 5 | 
|
| 6 |
|
| 7 |
|
| 8 | ## Getting Started
|
| 9 |
|
| 10 | 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.
|
| 11 |
|
| 12 | 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.
|
| 13 |
|
| 14 | 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.
|
| 15 |
|
| 16 | 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.
|
| 17 |
|
| 18 |
|
| 19 | ### Debugging
|
| 20 |
|
| 21 | See the [debugging guide](http://yeoman.io/authoring/debugging.html).
|
| 22 |
|
| 23 | ## Contributing
|
| 24 |
|
| 25 | We love contributors! See our [contribution guideline](http://yeoman.io/contributing/) to get started.
|
| 26 |
|
| 27 | ## Sponsors
|
| 28 | Love Yeoman work and community? Help us keep it alive by donating funds to cover project expenses! <br />
|
| 29 | [[Become a sponsor](https://opencollective.com/yeoman#support)]
|
| 30 |
|
| 31 | <a href="https://opencollective.com/yeoman/backers/0/website" target="_blank">
|
| 32 | <img src="https://opencollective.com/yeoman/backers/0/avatar">
|
| 33 | </a>
|
| 34 | <a href="https://opencollective.com/yeoman/backers/1/website" target="_blank">
|
| 35 | <img src="https://opencollective.com/yeoman/backers/1/avatar">
|
| 36 | </a>
|
| 37 | <a href="https://opencollective.com/yeoman/backers/2/website" target="_blank">
|
| 38 | <img src="https://opencollective.com/yeoman/backers/2/avatar">
|
| 39 | </a>
|
| 40 | <a href="https://opencollective.com/yeoman/backers/3/website" target="_blank">
|
| 41 | <img src="https://opencollective.com/yeoman/backers/3/avatar">
|
| 42 | </a>
|
| 43 | <a href="https://opencollective.com/yeoman/backers/4/website" target="_blank">
|
| 44 | <img src="https://opencollective.com/yeoman/backers/4/avatar">
|
| 45 | </a>
|
| 46 | <a href="https://opencollective.com/yeoman/backers/5/website" target="_blank">
|
| 47 | <img src="https://opencollective.com/yeoman/backers/5/avatar">
|
| 48 | </a>
|
| 49 | <a href="https://opencollective.com/yeoman/backers/6/website" target="_blank">
|
| 50 | <img src="https://opencollective.com/yeoman/backers/6/avatar">
|
| 51 | </a>
|
| 52 | <a href="https://opencollective.com/yeoman/backers/7/website" target="_blank">
|
| 53 | <img src="https://opencollective.com/yeoman/backers/7/avatar">
|
| 54 | </a>
|
| 55 | <a href="https://opencollective.com/yeoman/backers/8/website" target="_blank">
|
| 56 | <img src="https://opencollective.com/yeoman/backers/8/avatar">
|
| 57 | </a>
|
| 58 | <a href="https://opencollective.com/yeoman/backers/9/website" target="_blank">
|
| 59 | <img src="https://opencollective.com/yeoman/backers/9/avatar">
|
| 60 | </a>
|
| 61 | <a href="https://opencollective.com/yeoman/backers/10/website" target="_blank">
|
| 62 | <img src="https://opencollective.com/yeoman/backers/10/avatar">
|
| 63 | </a>
|
| 64 | <a href="https://opencollective.com/yeoman/backers/11/website" target="_blank">
|
| 65 | <img src="https://opencollective.com/yeoman/backers/11/avatar">
|
| 66 | </a>
|
| 67 | <a href="https://opencollective.com/yeoman/backers/12/website" target="_blank">
|
| 68 | <img src="https://opencollective.com/yeoman/backers/12/avatar">
|
| 69 | </a>
|
| 70 | <a href="https://opencollective.com/yeoman/backers/13/website" target="_blank">
|
| 71 | <img src="https://opencollective.com/yeoman/backers/13/avatar">
|
| 72 | </a>
|
| 73 | <a href="https://opencollective.com/yeoman/backers/14/website" target="_blank">
|
| 74 | <img src="https://opencollective.com/yeoman/backers/14/avatar">
|
| 75 | </a>
|
| 76 | <a href="https://opencollective.com/yeoman/backers/15/website" target="_blank">
|
| 77 | <img src="https://opencollective.com/yeoman/backers/15/avatar">
|
| 78 | </a>
|
| 79 | <a href="https://opencollective.com/yeoman/backers/16/website" target="_blank">
|
| 80 | <img src="https://opencollective.com/yeoman/backers/16/avatar">
|
| 81 | </a>
|
| 82 | <a href="https://opencollective.com/yeoman/backers/17/website" target="_blank">
|
| 83 | <img src="https://opencollective.com/yeoman/backers/17/avatar">
|
| 84 | </a>
|
| 85 | <a href="https://opencollective.com/yeoman/backers/18/website" target="_blank">
|
| 86 | <img src="https://opencollective.com/yeoman/backers/18/avatar">
|
| 87 | </a>
|
| 88 | <a href="https://opencollective.com/yeoman/backers/19/website" target="_blank">
|
| 89 | <img src="https://opencollective.com/yeoman/backers/19/avatar">
|
| 90 | </a>
|
| 91 | <a href="https://opencollective.com/yeoman/backers/20/website" target="_blank">
|
| 92 | <img src="https://opencollective.com/yeoman/backers/20/avatar">
|
| 93 | </a>
|
| 94 | <a href="https://opencollective.com/yeoman/backers/21/website" target="_blank">
|
| 95 | <img src="https://opencollective.com/yeoman/backers/21/avatar">
|
| 96 | </a>
|
| 97 | <a href="https://opencollective.com/yeoman/backers/22/website" target="_blank">
|
| 98 | <img src="https://opencollective.com/yeoman/backers/22/avatar">
|
| 99 | </a>
|
| 100 | <a href="https://opencollective.com/yeoman/backers/23/website" target="_blank">
|
| 101 | <img src="https://opencollective.com/yeoman/backers/23/avatar">
|
| 102 | </a>
|
| 103 | <a href="https://opencollective.com/yeoman/backers/24/website" target="_blank">
|
| 104 | <img src="https://opencollective.com/yeoman/backers/24/avatar">
|
| 105 | </a>
|
| 106 | <a href="https://opencollective.com/yeoman/backers/25/website" target="_blank">
|
| 107 | <img src="https://opencollective.com/yeoman/backers/25/avatar">
|
| 108 | </a>
|
| 109 | <a href="https://opencollective.com/yeoman/backers/26/website" target="_blank">
|
| 110 | <img src="https://opencollective.com/yeoman/backers/26/avatar">
|
| 111 | </a>
|
| 112 | <a href="https://opencollective.com/yeoman/backers/27/website" target="_blank">
|
| 113 | <img src="https://opencollective.com/yeoman/backers/27/avatar">
|
| 114 | </a>
|
| 115 | <a href="https://opencollective.com/yeoman/backers/28/website" target="_blank">
|
| 116 | <img src="https://opencollective.com/yeoman/backers/28/avatar">
|
| 117 | </a>
|
| 118 | <a href="https://opencollective.com/yeoman/backers/29/website" target="_blank">
|
| 119 | <img src="https://opencollective.com/yeoman/backers/29/avatar">
|
| 120 | </a>
|
| 121 |
|
| 122 |
|
| 123 | ## License
|
| 124 |
|
| 125 | [BSD license](http://opensource.org/licenses/bsd-license.php)
|
| 126 | Copyright (c) Google
|