X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=a6d2af2562ef95753a56352a3bba3da8acdc2fa5;hb=f4d156213ec44c605b59003b070975cec1c4b736;hp=03f2646c7e38fb4209b8e686d880d55b013c7808;hpb=82bf6ead56209e4211527cf0a99d262bbb4bb28d;p=charsel.git diff --git a/README.md b/README.md index 03f2646..a6d2af2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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 shell script should work fine for most people, or you could manually copy the files into place using it as a template. 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. @@ -28,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 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) +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