https://github.com/nexxeln/license-generator

Create licenses for your projects right from your terminal!
https://github.com/nexxeln/license-generator

cli license productivity rust

Last synced: 5 days ago
JSON representation

Create licenses for your projects right from your terminal!

• Host: GitHub
• URL: https://github.com/nexxeln/license-generator
• Owner: nexxeln
• License: mit
• Created: 2022-03-23T17:23:05.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-31T19:31:05.000Z (10 months ago)
• Last Synced: 2024-05-01T16:49:24.134Z (9 months ago)
• Topics: cli, license, productivity, rust
• Language: Rust
• Homepage: https://crates.io/crates/gen-license
• Size: 43 KB
• Stars: 144
• Watchers: 5
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/funding.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
License Generator


![demo](https://us-east-1.tixte.net/uploads/nexxel.needs.rest/idea64_rZlJLu450P.gif)



### Overview

This is a blazing fast ⚡, command line license generator for your open source projects written in Rust.

I know that GitHub has a great GUI to add licenses to projects but I always found myself doing too much work. First you have to go to GitHub, create a file, type 'LICENSE', pick a license, push it and then pull it locally. With this you can just generate the license locally and push it to GitHub.

I had not written some Rust code in a while so I made this simple project to brush up my Rust skills a bit (still very beginner).

### Installation

#### Using Cargo

```bash

cargo install gen-license

```

#### Using AUR (Arch/Arch-based Linux Distros)

```

yay -S gen-license

```

#### From source

```bash

git clone https://github.com/nexxeln/license-generator.git

cd license-generator

cargo install --path .

```

If you don't have cargo installed, you can download the executable from the [releases](https://github.com/nexxeln/license-generator/releases) section.

### Usage

```bash

gen-license

```

### Contributing

- Fork the repository

- Create a branch

  ```bash

  git checkout -b fix/amazingFix

  ```

- Commit your changes and push to your branch

  ```bash

  git commit -m "made an amazingFix"

  git push origin fix/amazingFix

  ```

- Open a pull request