generator-init
Version:
A generator for INIT.
50 lines (30 loc) • 2.04 kB
Markdown
# generator-init v0.1.2
<img src="http://rawgithub.com/use-init/init/master/logo.svg" alt="INIT" title="INIT" width="200" align="right">
[](https://bitdeli.com/free "Bitdeli Badge")
[](https://travis-ci.org/use-init/generator-init)
[](http://badge.fury.io/js/generator-init)
[](http://gruntjs.com/)
A [Yeoman](http://yeoman.io) generator for [INIT](http://use-init.com).
> INIT is based upon HTML5 Boilerplate and adds more structure for SCSS and JavaScript files, includes build tasks and a whole lot more.
Currently this generator scaffolds INIT [v1.0.2](https://github.com/use-init/init/releases/tag/v1.0.2).
Maintained by: [@kahlil](https://github.com/kahlil)
Contributors: [@sergiovilar](https://github.com/sergiovilar), [@drublic](https://github.com/drublic)
## Main Generator
Install and use the generator by typing the following into the command line:
```sh
npm install -g yo
npm install -g generator-init
yo init
```
#### Sub-Generator init:page
Use `yo init:page '<pagename>'` to create a new page snippet for INITs simple static page generator.
####Sub-Generator init:module
Use `yo init:module 'modulename'` to scaffold a new JavaScript module.
#### Sub-Generator init:jqueryplugin
Use `yo init:jqueryplugin 'pluginame'` to scaffold a new jQuery Plugin with the name `jquery.<pluginname>.js`.
## Advice
<p align="center">
<img src="https://raw.github.com/use-init/generator-init/master/scaffoldallthethings.png" alt="SCAFFOLD ALL THE THINGS!!1!" title="SCAFFOLD ALL THE THINGS!!1!" width="500" height="355" align="center">
</p>
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).