rdm - ReadMe scaffolding

Command line tool to create default LICENSE.md, CODE_OF_CONDUCT.md and README.md files for your typical GitHub open source project.

Features

• Create LICENSE.md (MIT or unlicense)
• Create CODE_OF_CONDUCT.md (By Contributor Covenant)

$ > rdm

Scaffold common GitHub project files.

Usage:
  rdm [command]

Available Commands:
  conduct     Generate CODE_OF_CONDUCT.md file
  help        Help about any command
  license     Generate LICENSE.md file
  version     Show command version

Flags:
      --config string   config file (default is $HOME/.rdm.yaml)
  -f, --force           Overwrite files
  -o, --out string      output path (default is current directory)

Install

$ > brew tap sbstjn/bin
$ > brew install rdm
$ > rdm version
0.0.3

Usage

Project License

Choose either to unlicense your code, or use the default MIT license for your project.

$ > rdm license # -o destination/path, default is current directory

Code of Conduct

Generate a CODE_OF_CONDUCT.md file based on Contributor Covenant.

$ > rdm conduct # -o destination/path, default is current directory

Contribute

Run make bindata after you update a template. 🙆

Todo

• Generate README.md
  • Support for different sections (shields.io etc.)
• Generate LICENSE.md (MIT, Unlicense)
• Generate CODE_OF_CONDUCT.md
• Presets for different languages (Node, Go)
• Use git config for default values