Generate a license file. Choose any of the licenses supported by https://github.com/github/choosealicense.com.
generate-license
(TOC generated by verb using markdown-toc)
Install
To run this generator from the command line you must install both generate and generate-license:
# install generate and generate-license $ npm install --global generate generate-license# install only generate-license $ npm install --global generate-licenseGenerate a license
Use generate's CLI to write a license file to the current working directory:
# prompts you to choose a license to generate $ gen licenseThe 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:mitSpecify output directory
# write a license file to "some-folder/LICENSE" $ gen license -d some-folderAPI
Visit generate's documenatation to learn how to use this generator as a plugin or sub-generator.
Getting started
Install
Installing the CLI
To run the readme generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:
$ npm install --global generateThis adds the gen command to your system path, allowing it to be run from any directory.
Install generate-license
Install this module with the following command:
$ npm install --global generate-licenseCLI
Run this generator's default task with the following command:
$ gen readmeWhat you should see in the terminal
If completed successfully, you should see both starting and finished events in the terminal, like the following:
[00:44:21] starting ......[00:44:22] finished ✔If you do not see one or both of those events, please let us know about it.
Help
To see a general help menu and available commands for Generate's CLI, run:
$ gen helpAvailable tasks
All available tasks for this generator.
default
The default task prompts you to choose the LICENSE to generate. All licenses from github/choosealicense.com are available.
Example
$ gen license$ gen license --dest ./docs# or $ gen license:choose$ gen license:choose --dest ./docsVisit Generate's documentation for tasks.
Next steps
Running unit tests
It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:
$ npm install && testPublishing your generator
If you're tests are passing and you're ready to publish your generator to npm, you can do that now with the following command:
Are you sure you're ready?!
Let's go!
$ npm publishAbout
What is "Generate"?
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.
Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.
For more information:
- Visit the generate project
- Visit the generate documentation
- Find generators on npm (help us author generators)
Related projects
- generate-eslint: Generate a new
.eslintrc.jsonor.eslintignorefile from a pre-defined or user-defined template. Can be… more | homepage - generate-install: Generator that automatically detects the dependencies or devDependencies to install based on the templates or… more | homepage
- generate-package: Generate a package.json from a pre-defined or user-defined template. This generator can be used from… more | homepage
Community
Bigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:
- Show your love by starring the project
- Tweet about Generate. Mention using
@generatejs, or use the#generatejshashtag - Get implementation help on StackOverflow with the
generatejstag - Discuss Generate with us on Gitter
- If you publish a generator, to make your project as discoverable as possible, please add the unique keyword
generategeneratorto your project's package.json.
Contributors
| Commits | Contributor |
|---|---|
| 78 | jonschlinkert |
| 10 | pointnet |
| 4 | doowb |
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testAuthor
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on October 17, 2017.