Repository files navigation

Generate a starter CHANGELOG.md file, using conventions from keep-a-changelog. Use from the command line when Generate's CLI is installed globally, or use as a plugin or sub-generator in your own generator.

• Quickstart
• What is "Generate"?
• Getting started
  • Install
  • Usage
  • Help
• About
  • Related projects
  • Community
  • Contributing
  • Running tests
  • Release history
  • Author
  • License

(TOC generated byverb usingmarkdown-toc)

Install

Installgenerate andgenerate-log:

$ npm install --global generate generate-log

Generate a CHANGELOG.md file

Generate aCHANGELOG.md file to the current working directory:

$ gen log

Generate is a command line tool and developer framework for scaffolding out new GitHub projects usinggenerators andtasks.

Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support forgulp,base andassemble plugins, and much more.

For more information:

• Visit thegenerate project
• Visit thegenerate documentation
• Findgenerators on npm (help usauthor generators)

Installing the CLI

To run thelog generator from the command line, you'll need to installGenerate globally first. You can do that now with the following command:

$ npm install --global generate

This adds thegen command to your system path, allowing it to be run from any directory.

Install generate-log

Install this module with the following command:

$ npm install --global generate-log

Run this generator'sdefaulttask with the following command:

$ gen log

What you should see in the terminal

If completed successfully, you should see bothstarting andfinished 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, pleaselet us know about it.

To see a general help menu and available commands for Generate's CLI, run:

$ genhelp

All available tasks.

Generate achangelog.md file. For API usage this task is also aliased aschangelog.

Example

$ gen generator:log

Visit Generate'sdocumentation for tasks.

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&&test

If you're tests are passing and you're ready to publish your generator tonpm, you can do that now with the following command:

Are you sure you're ready?!

Let's go!

$ npm publish

• generate-gitignore: Generate a .gitignore file from the command line when Generate's CLI is installed globally, or…more |homepage
• generate-license: Generate a license file for a GitHub project. |homepage
• generate-project: Scaffold out complete code projects from the command line, or use this generator as a…more |homepage

Are you usingGenerate in your project? Have you published agenerator and want to share your project with the world?

Here are some suggestions!

• If you get like Generate and want to tweet about it, please feel free to mention@generatejs or use the#generatejs hashtag
• Show your love by starringGenerate andgenerate-log
• Get implementation help onStackOverflow (please use thegeneratejs tag in questions)
• Gitter Discuss Generate with us onGitter
• If you publish an generator, thank you! To make your project as discoverable as possible, please add the keywordgenerategenerator to package.json.

Pull requests and stars are always welcome. For bugs and feature requests,please create an issue.

Install dev dependencies:

$ npm install -d&& npmtest

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Copyright © 2016,Jon Schlinkert.Released under theMIT license.

This file was generated byverb-generate-readme, v0.1.30, on August 19, 2016.