X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;h=e6849412424d7692a8cdcbe5ff257c6f1087a8b5;hp=4b073cb85e099ee81c644735acc78840c4eb401b;hb=e36a2f02097f2db0b61dfda774514a60ecf50014;hpb=80b5946548fcc4087fb7af79b1bda98d6985338f diff --git a/README.md b/README.md index 4b073cb..e684941 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,15 @@ A very simple shell script to make copying frequently used special characters to It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard. ## Installation -Running the INSTALL.sh script should work fine for most people +Running the INSTALL.sh script should work fine for most people. + If it is run as root or with sudo, the program and charfiles will be installed for all users. If it is run without elevated privileges, it will just be installed for the local user. ## Dependencies -Posix shell -util-linux -xclip -A terminal with UTF-8 encoding enabled + * Posix shell + * util-linux + * xclip + * A terminal with UTF-8 encoding enabled ## USAGE To start the program, run `charsel ` @@ -27,6 +28,9 @@ Make a new file in `~/.local/share/charsel/` or `/usr/share/charsel` with the na Fill it in, using the provided examples as a template. Hidden shortcuts go above the '---' ## LICENSE -charfile is GPLv3 licensed -See COPYING for more information -charfile is written by (Armaan Bhojwani)[https://armaan.bhojwani.org]. (Email)[3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me] +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) + +## BRANCHES +Development happens on the "development" branch, which then gets merged into the "master" branch once its ready for a stable release