Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.11 KB

.verb.md

File metadata and controls

44 lines (30 loc) · 1.11 KB
Raw

Install

To run this generator from the command line you must install both [generate][] and {%= name %}:

# install generate and {%= name %}
$ npm install --global generate {%= name %}
# install only {%= name %}
$ npm install --global {%= name %}

Generate a license

Use [generate's CLI][generate] to write a license file to the current working directory:

# prompts you to choose a license to generate
$ gen license

The file is automatically named according to preferences defined at GitHub's choosealicense.com repository (usually it's LICENSE, but not always. See the license files in that repository for more details).

Specify the license to generate

If you don't want to be prompted, you can specify the license up front:

$ gen license:<license name>
# example
$ gen license:mit

Specify output directory

# write a license file to "some-folder/LICENSE"
$ gen license -d some-folder

API

Visit [generate's documenatation][generate] to learn how to use this generator as a plugin or sub-generator.