license-tool/README.md

21 lines
942 B
Markdown

# license-tool
[![Build Status - Linux](https://ci.zander.im/job/license-tool-linux/badge/icon?style=plastic&subject=Build%20-%20Linux)](https://ci.zander.im/job/license-tool-linux/)
[![Build Status - FreeBSD](https://ci.zander.im/job/license-tool-freebsd/badge/icon?style=plastic&subject=Build%20-%20FreeBSD)](https://ci.zander.im/job/license-tool-freebsd/)
A simple tool for creating `LICENSE` files.
### Installation
To install, simply run the `install.sh` script. It takes an optional argument
that is the install prefix. This defaults to `/usr/local`.
### Usage
> `license-tool [-h] [-o OUTFILE] <license>`
Use the `-h` flag to get a list of installed licenses.
### Additional licenses
To add additional licenses, just put them in the `licenses/` directory. The name
of the file (INCLUDING the extension) will be used as the license name. After
adding a new license, you must run `install.sh` again for the change to change
effect.