removed obnoxious license message, added nato charfile, fixed shebang

[charsel.git] / README.md

diff --git a/README.md b/README.md
index 4b073cb85e099ee81c644735acc78840c4eb401b..9886a9f7c61892ec5f329f763d41d2681212e5fa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,14 +4,14 @@ 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
-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.
+Run `make install` as root to install  
+Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
 ## 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 <charfile>`
@@ -27,6 +27,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 "main" branch once its ready for a stable release