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