Generate a robots.txt for a web project (uses the robots.txt from HTML5 Boilerplate). This can be run from the command line when Generate is installed globally, or used as a plugin in another generator.
What is "Generate"?
For more information:
- Visit the generate project
- Visit the generate documentation
- Find generators on npm (help us author generators)
Installing the CLI
To run the
robots 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 generate
This adds the
gen command to your system path, allowing it to be run from any directory.
Install this module with the following command:
$ npm install --global generate-robots
Run this generator's
default task with the following command:
$ gen robots
What you should see in the terminal
If completed successfully, you should see both
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.
To see a general help menu and available commands for Generate's CLI, run:
$ gen help
All available tasks.
robots.txt file to the current working directory or specified
$ gen robots$ gen robots --dest ./foo
Visit Generate's documentation for tasks.
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 && test
Publishing 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?!
$ npm publish
- generate-eslint: Generate a new
.eslintignorefile from a pre-defined or user-defined template. Can be… more | homepage
- generate-gitignore: Generate any local or global .gitignore file from the github/gitignore repository. Use from the command… more | homepage
- generate-license: Generate a license file for a GitHub project. | homepage
Here are some suggestions!
- If you get like Generate and want to tweet about it, please feel free to mention
@generatejsor use the
- Show your love by starring Generate and
- Get implementation help on StackOverflow (please use the
generatejstag in questions)
- Gitter Discuss Generate with us on Gitter
- If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
$ npm install -d && npm test
This file was generated by verb-generate-readme, v0.1.30, on September 09, 2016.