X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=451ecc1ea208c3577b3fe24958d2e9acbd0c7578;hb=974c7bf0dcf3fa8d77e93400fa69acf931950503;hp=0d3f76545953488b512b9919af2cc82128893fe3;hpb=8e0de4ff8f74d6ee3ddccd50747e1c24c94d1e0d;p=charsel.git diff --git a/README.md b/README.md index 0d3f765..451ecc1 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ Run `make install` as root to install Run `make uninstall` as root to remove. Will not delete your personal charfiles ## Dependencies - * bash - * util-linux - * xclip + * Bash + * Linux + * Xclip * A terminal with UTF-8 encoding enabled -## USAGE +## Usage To start the program, run `charsel ` This will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`. @@ -21,12 +21,12 @@ Once you have started the program, simply type the shortcut listed on the left s The default charfiles all have hidden shortcuts for capital letters that are not shown on the table. Simply type a capital version of the shortcut key to access the capital version of the special character. -## CREATING A CHARFILE +## Creating a charfile Make a new file in `~/.local/share/charsel/` or `/usr/share/charsel` with the name that you would like to use to call the charfile in the command. Fill it in, using the provided examples as a template. Hidden shortcuts go above the '---' -## LICENSE +## License Charfile is GNU GPLv3 licensed, see COPYING for more information Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)