generator-standard-readme - GitLite

KO | EN

gitlite — search

#typescript #llm #android #machine-learning #rust #docker #macos #windows #cli #awesome-list #security #ios #openai #open-source

generator-standard-readme

(★ 215)

Scaffold out a Standard Readme

File Explorer

Download Latest Version (.zip)

- - ci.yml
- - README.md
- bin.js
- index.js
- api-readme.md
- background-readme.md
- badges-readme.md
- banner-readme.md
- contributing-file-readme.md
- default-readme.md
- different-license-readme.md
- different-year.md
- maximal-readme.md
- no-badge-readme.md
- no-long-description-readme.md
- prs-readme.md
- security-readme.md
.gitattributes
.gitignore
.travis.yml
license
package-lock.json
package.json
README.md
test.js
vitest.config.js

# Installation Guide

1. Get the code

git clone https://github.com/RichardLitt/generator-standard-readme

Downloads the entire project code from GitHub to your computer.

cd generator-standard-readme

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install --global yo generator-standard-readme

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install --global yo generator-standard-readme

Installs the package published on the npm registry globally — no need to clone the source.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# generator-standard-readme

[![Build Status](https://github.com/RichardLitt/generator-standard-readme/actions/workflows/ci.yml/badge.svg)](https://github.com/RichardLitt/generator-standard-readme/actions/workflows/ci.yml)

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)