1
0
licensmith/README.md
Wiktor Zykubek 1a178ccaec
All checks were successful
Build / build (push) Successful in 25s
docs: update README.md
2024-12-27 15:30:16 +01:00

1020 B

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:

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:

licensmith --license ISC --name "John Doe" --email "jdoe@example.com"

To list available templates run:

licensmith --list

Installation

There are different ways to get Licensmith:

  1. Use prebuilt binaries:

  2. Install from source: see Compilation

Compilation

git clone https://git.brono.cloud/wzykubek/licensmith.git
cd licensmith
go build -v ./...