Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RichardLitt/generator-standard-readme
Scaffold out a Standard Readme
https://github.com/RichardLitt/generator-standard-readme
documentation fill generator readme scaffold standard standard-readme yeoman
Last synced: about 1 month ago
JSON representation
Scaffold out a Standard Readme
- Host: GitHub
- URL: https://github.com/RichardLitt/generator-standard-readme
- Owner: RichardLitt
- License: mit
- Created: 2016-05-13T21:33:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-23T15:12:38.000Z (11 months ago)
- Last Synced: 2024-08-15T08:51:37.674Z (about 1 month ago)
- Topics: documentation, fill, generator, readme, scaffold, standard, standard-readme, yeoman
- Language: JavaScript
- Homepage:
- Size: 739 KB
- Stars: 202
- Watchers: 8
- Forks: 48
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# generator-standard-readme
[](https://travis-ci.org/RichardLitt/generator-standard-readme)
Scaffold out a Standard Readme
This generator conforms to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. It creates a minimally compliant standard readme for your cross-language project, with some options.
Tip: Use [chalk](https://github.com/sindresorhus/chalk) if you want colors in your CLI.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Fields to fill out](#fields-to-fill-out)
- [Contributing](#contributing)
- [License](#license)
## Install
This generator requires [node](https://nodejs.org), [npm](https://npmjs.com), and [yeoman](http://yeoman.io/).
You can install it by running:
```sh
npm install --global yo generator-standard-readme
```
## Usage
With [yo](https://github.com/yeoman/yo):
```
$ yo standard-readme
```
This will write a file, `readme.md`, to the local directory.
### Fields to fill out
`standard-readme` will ask you a set of questions, which will help it fill out the README. These are:
- What do you want to name your module?
- What is the description of this module?
- Do have a banner image?
- Where is the banner image? Ex: \'img/banner.png\'
- Do you want a TODO dropped where your badges should be?
- Do you want a TODO dropped where your long description should be?
- Do you need a prioritized security section?
- Do you need a background section?
- Do you need an API section?
- What is the GitHub handle of the main maintainer?
- Do you have a CONTRIBUTING.md file?
- Are PRs accepted?
- Is an MIT license OK?
- What is your license?
- Who is the License holder (probably your name)?
- Use the current year?
- What years would you like to specify?
## Maintainer
[@RichardLitt](https://github.com/RichardLitt)
## Contributing
Please contribute! [Look at the issues](https://github.com/RichardLitt/generator-standard-readme/issues).
## License
MIT © 2016 [Richard Littauer](http://burntfen.com)