1
0
licensmith/README.md

37 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2024-12-27 04:47:24 +01:00
# 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 --license 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 --license ISC --name "John Doe" --email "jdoe@example.com"
```
To list available templates run:
```bash
licensmith --list
```
2024-12-27 15:30:16 +01:00
## Installation
There are different ways to get Licensmith:
1. Use prebuilt binaries:
2024-12-27 22:24:03 +01:00
- [Releases](https://github.com/wzykubek/licensmith/releases): Stable versions
- [Actions](https://github.com/wzykubek/licensmith/actions): Development versions
2024-12-27 15:30:16 +01:00
2024-12-27 22:24:03 +01:00
2. Install from source: see [compilation](#compilation) section
2024-12-27 15:30:16 +01:00
## Compilation
```bash
git clone https://github.com/wzykubek/licensmith
cd licensmith
go build -v ./...
```