]> git.armaanb.net Git - charsel.git/blobdiff - README.md
switch to codeberg
[charsel.git] / README.md
index a6d2af2562ef95753a56352a3bba3da8acdc2fa5..9886a9f7c61892ec5f329f763d41d2681212e5fa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,9 +4,8 @@ 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 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.
+Run `make install` as root to install  
+Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
 ## Dependencies
   * Posix shell  
@@ -33,4 +32,4 @@ 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
+Development happens on the "development" branch, which then gets merged into the "main" branch once its ready for a stable release