clarified creating a charfile

[charsel.git] / README.md

diff --git a/README.md b/README.md
index a356335653d7f8d2c954ac53532ed6ffbac8d6c8..b0f81dc084a4906e3fd7938da9b8bf8e31001f15 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,35 @@
 # 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` to remove charsel files from your home directory
+- Run `make install-completions` to install the shell completions
 
 ## Dependencies
   * Bash
   * Linux
-  * Xclip
-  * A terminal with UTF-8 encoding enabled
+  * Xclip (using the -n flag bypasses this)
+  * A terminal with UTF-8 encoding enabled (most desktop environment's default terminal will be fine)
 
 ## 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
+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, type ';' as a shortcode
 
 Some of the default charfiles have hidden shortcuts for capital letters that are not shown on the table. Simply type a capital version of the shortcut key to access the capital version of the special character.
 
 ## Creating a charfile
-Make a new file in the `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` directories with the name that you would like to use to call the charfile in the command.
+Make a new file in `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` with the name that you would like to use to call the charfile in the command.
 
-Fill it in, using the provided examples as a template. Hidden shortcuts go above the '-', lines can be commented out using a '#' at the start of the line
+Fill in your shortcodes, using the provided examples in `/usr/share/charsel/charfiles` as a template. There are just 4 rules to follow.
+  1. The pattern is "shortcode,output"
+  2. Hidden shortcuts go above the line with '---'
+  3. Lines can be commented out using a '#' at the start
+  4. ";" cannot be used as a shortcode, as that is used to quit the program
 
 ## License
 Charfile is GNU GPLv3 licensed, see COPYING for more information