https://github.com/generate/generate-example
Example generator, to show how Generate works.
https://github.com/generate/generate-example
Last synced: about 1 year ago
JSON representation
Example generator, to show how Generate works.
- Host: GitHub
- URL: https://github.com/generate/generate-example
- Owner: generate
- License: mit
- Created: 2016-07-03T11:21:21.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-03T11:24:05.000Z (almost 10 years ago)
- Last Synced: 2025-04-13T02:03:07.513Z (about 1 year ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generate-example [](https://www.npmjs.com/package/generate-example) [](https://npmjs.org/package/generate-example) [](https://travis-ci.org/generate/generate-example)
Example Generate generator, to show how Generate works.
## What is "Generate"?
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [plugins](https://github.com/generate/generate/blob/master/docs/plugins.md) ,[generators](https://github.com/generate/generate/blob/master/docs/generators.md) and[tasks](https://github.com/generate/generate/blob/master/docs/tasks.md) . Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build.
For more information:
* Visit the [generate project](https://github.com/generate/generate)
* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)
* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author micro-generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md) )
## What is generate-example?
This generator's ["default" task](https://github.com/generate/generate/blob/master/docs/generators.md#cli-default-task) simply generate's an`example.txt` file in the current working directory to demonstrate how Generate works.
## Install
**Install Generate**
If you haven't already installed [Generate](https://github.com/generate/generate) globally, you can do that now with the following command:
```sh
$ npm install --global generate
```
**Install generate-example**
Then install this module:
```sh
$ npm install --global generate-example
```
## Usage
Run the generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default-task) with the following command:
```sh
$ gen example
```
## Tasks
Visit the [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).
## Related projects
You might also be interested in these projects:
[generate](https://www.npmjs.com/package/generate): The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "The Santa Claus machine for GitHub projects. Scaffolds out new projects, or creates any kind of required file or document from any given templates or source materials.")
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/generate/generate-example/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 03, 2016._