]> git.armaanb.net Git - charsel.git/blobdiff - README.md
added purge option
[charsel.git] / README.md
index a356335653d7f8d2c954ac53532ed6ffbac8d6c8..9df7c548e892bf83d38a57c5cf7959002a90ec64 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
 # CHARSEL
 A simple bash script to make copying frequently used special characters to your clipboard easy.
 
-It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
+It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
 
 ## Installation
-Run `make install` as root to install
-Run `make uninstall` as root to remove. Will not delete your personal charfiles
+- Run `make install` as root to install
+- Run `make uninstall` as root to remove. Will not delete your personal charfiles
+- Run `make purge` as a normal user to remove charsel files from your home directory
 
 ## Dependencies
   * Bash
@@ -14,7 +15,7 @@ Run `make uninstall` as root to remove. Will not delete your personal charfiles
   * A terminal with UTF-8 encoding enabled
 
 ## Usage
-For usage, use `charsel -h`
+For argument usage, use `charsel -h`
 
 Once you have started the program, simply type the shortcut listed on the left side of the table to copy the character on the right side of the table to your clipboard. Shortcodes the same length as the longest one will automatically be entered. To quit, use ^C