thiagolcks / generator-wp-plugin-boilerplate

A generator for Yeoman to customize the WP Plugin Boilerplate (https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate).
MIT License
16 stars 2 forks source link

generator-wp-plugin-boilerplate

A generator for Yeoman to customize the WP Plugin Boilerplate

Getting Started

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

Install the generator

$ npm install -g generator-wp-plugin-boilerplate

How to use it

# Go to the plugin directory of your WP
cd wp-content/plugins
# Run the generator
$ yo wp-plugin-boilerplate

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 License