42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
# Licensmith
|
|
|
|
Effortlessly craft the perfect LICENSE for your Git repo in seconds with a single command!
|
|
|
|
## Usage
|
|
This command will generate ISC `LICENSE` file in your current directory, including current year, and your name read from Git configuration:
|
|
```bash
|
|
licensmith add ISC
|
|
```
|
|
|
|
By default, Licensmith read your local repository looking for user details (name and e-mail), as a fallback it uses global configuration.
|
|
|
|
You can also specify different values using:
|
|
```bash
|
|
licensmith add ISC --name "John Doe" --email "jdoe@example.com"
|
|
```
|
|
|
|
To list available templates:
|
|
```bash
|
|
licensmith list
|
|
```
|
|
|
|
To show license summary:
|
|
```bash
|
|
licensmith show ISC
|
|
```
|
|
|
|
## Installation
|
|
There are different ways to get Licensmith:
|
|
1. Use prebuilt binaries:
|
|
- [Releases](https://github.com/wzykubek/licensmith/releases): Stable versions
|
|
- [Actions](https://github.com/wzykubek/licensmith/actions): Development versions
|
|
|
|
2. Install from source: see [compilation](#compilation) section
|
|
|
|
## Compilation
|
|
```bash
|
|
git clone https://github.com/wzykubek/licensmith
|
|
cd licensmith
|
|
go build -v ./...
|
|
```
|