https://github.com/sbstjn/rdm
Scaffold common GitHub project files like README, CoC, or LICENSE.md
https://github.com/sbstjn/rdm
github license readme scaffolding
Last synced: 10 months ago
JSON representation
Scaffold common GitHub project files like README, CoC, or LICENSE.md
- Host: GitHub
- URL: https://github.com/sbstjn/rdm
- Owner: sbstjn
- License: mit
- Created: 2017-06-04T15:08:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-18T22:18:00.000Z (over 8 years ago)
- Last Synced: 2025-02-09T02:30:00.767Z (12 months ago)
- Topics: github, license, readme, scaffolding
- Language: Go
- Homepage:
- Size: 45.9 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# rdm - ReadMe scaffolding
[](https://circleci.com/gh/sbstjn/rdm)
[](https://github.com/sbstjn/rdm/releases)
[](https://github.com/sbstjn/rdm/blob/master/LICENSE.md)
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](https://opensource.org/licenses/MIT) or [unlicense](http://unlicense.org/))
- Create `CODE_OF_CONDUCT.md` (By [Contributor Covenant](http://contributor-covenant.org/version/1/4/))
```bash
$ > 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
```bash
$ > brew tap sbstjn/bin
$ > brew install rdm
$ > rdm version
0.0.3
```
## Usage
### Project License
Choose either to [unlicense your code](http://unlicense.org/), or use the default [MIT](https://opensource.org/licenses/MIT) license for your project.
```bash
$ > rdm license # -o destination/path, default is current directory
```
### Code of Conduct
Generate a `CODE_OF_CONDUCT.md` file based on [Contributor Covenant](http://contributor-covenant.org/version/1/4/).
```bash
$ > 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.)
- [x] Generate LICENSE.md (MIT, Unlicense)
- [x] Generate CODE_OF_CONDUCT.md
- [ ] Presets for different languages (Node, Go)
- [ ] Use git config for default values