license

An opensource software license generator written in shell script base on baux and powered by GitHub's licenses API.

Table of Contents

• 🎨 Features
• 📏 Prerequisite
• 🚀 Installation
• 📝 Configuration
• 📓 Usage
• 🌺 Contributing
• 👦 Authors
• 📜 License

🎨 Features

• Support all licenses available on GitHub.
• Less dependences.
• Generate without network (except on first run).
• Configurable.

📏 Prerequisite

• bash
• coreutils
• sed
• curl
• jq

🚀 Installation

You can get this program with git:

$ git clone https://github.com/ishbguy/license

📝 Configuration

You can set you own config in $HOME/.licenserc:

# uncomment to set your own config
# all this three config can write in UPPER-CASE,
# so set AUTHOR, LICENSE_DIR, LICENSE_NAME is OK

# the name who has the copyright
author=ishbguy

# licenses download directory
license_dir=~/.license

# backgroup jobs when downloading licenses
license_jobs=8

📓 Usage

Generate a license to standard output

$ license.sh mit

Generate a license to a file:

$ license.sh -o LICENSE.txt mit

Specify the year and the author name:

$ license.sh -y 2018 -n ishbguy mit

Specify a license directory:

$ license.sh -d lic mit

Download(if no licenses exist in the specify directory) or update licenses:

$ license.sh -d lic -u

List all available licenses:

$ license.sh -l

Show information for choosing a license:

$ license.sh -c

🌺 Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

👦 Authors

• ishbguy

📜 License

Released under the terms of MIT License.