|
1 | | -# proctl |
| 1 | +# PROCTL |
| 2 | + |
| 3 | +> Manage, switch between templated licenses, and set languages |
| 4 | +
|
| 5 | +<p align='center'> |
| 6 | + <img src='https://img.shields.io/badge/Maintained-Yes-green?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 7 | + <img src='https://img.shields.io/github/last-commit/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 8 | + <img src='https://img.shields.io/github/repo-size/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 9 | + <img src='https://img.shields.io/github/issues/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 10 | + <img src='https://img.shields.io/github/stars/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 11 | + <img src='https://img.shields.io/github/forks/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 12 | + <img src="https://badges.pufler.dev/visits/The-Repo-Club/proctl?color=ff59f9&labelColor=434c5e&style=flat-square"/> |
| 13 | + <img src='https://img.shields.io/github/commit-activity/m/The-Repo-Club/proctl?colorA=434c5e&colorB=ff59f9&style=flat-square'> |
| 14 | +</p> |
| 15 | + |
| 16 | +# Dependencies |
| 17 | + |
| 18 | +- coreutils for stuff like `head`, `awk`, ... |
| 19 | +- fzf (optional) for `-pick-license`, `-pick-language` flags |
| 20 | +- git (optional) for generating info in default config automatically |
| 21 | +- ncurses (optional) for colours (`PROCTL_COLOURS=1`) using `tput` |
| 22 | + |
| 23 | +# Installation |
| 24 | + |
| 25 | +# How do I install proctl? |
| 26 | + |
| 27 | +[](https://github.com/basherpm/basher) |
| 28 | + |
| 29 | +### on Arch BTW? |
| 30 | + |
| 31 | +Follow one of the 3 simple ways to install below. |
| 32 | + |
| 33 | +Download: [PKGBUILD](https://github.com/The-Repo-Club/ArchAUR/raw/main/proctl/PKGBUILD) and make with `makepkg -sfi` |
| 34 | + |
| 35 | +Install: [Custom Repo](https://arch.therepo.club/) then just use `pacman -S proctl` |
| 36 | + |
| 37 | +AUR: [YAY](https://aur.archlinux.org/packages/proctl) just use `yay -S proctl` |
| 38 | + |
| 39 | +## Manual |
| 40 | + |
| 41 | +```bash |
| 42 | +git clone https://github.com/The-Repo-Club/proctl && cd proctl |
| 43 | + |
| 44 | +chmod a+rx proctl |
| 45 | + |
| 46 | +sudo install -Dm755 proctl /usr/local/bin |
| 47 | +``` |
| 48 | + |
| 49 | +# Configuration |
| 50 | + |
| 51 | +Configuration can be found in `~/.config/license.conf` and `~/.config/license.conf`, it is automatically |
| 52 | +generated on first launch or with the flag `-new-config` |
| 53 | + |
| 54 | +Example config: |
| 55 | + |
| 56 | +```sh |
| 57 | +#!/usr/bin/env sh |
| 58 | + |
| 59 | +export AUTHOR_NAME='Joe Doe' |
| 60 | +export AUTHOR_EMAIL= '[email protected]' |
| 61 | +export AUTHOR_WEBSITE='https://joe.doe/' |
| 62 | +export TEMPLATE_DIR='/usr/share/proctl' |
| 63 | +``` |
0 commit comments