update readme, fix -n bug, remove branding

[charsel.git] / README.md

diff --git a/README.md b/README.md
index c4bd7c3842b81d8c4c95e4a5eab84b1e74be848a..91724a207b71c986a33fa3e04e3cc02a233615a8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,35 @@
 # charsel
-A very simple comand line tool to make a shortcut to a special characther. 
-It takes the input of a .char file, then puts it into a table and waits for your input. Once you put in your shortcut key, it prints the special character then copies it to the clipboard.
-A .char file is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
+A simple bash script to make copying frequently used special characters to your clipboard easy.
 
-## DEPENDENCIES
-posix shell
-util-linux
-xclip
+It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
 
-## USAGE
-charselect.sh $charfile
+## Installation
+- Run `make` as root to install
+- Run `make uninstall` as root to remove
+- Run `make purge` to remove charsel files from your home directory
+- Run `make install-completions` to install the shell completions
+
+## Dependencies
+  * Bash
+  * Linux
+  * Xclip (using the -n flag bypasses this)
+  * A terminal with UTF-8 encoding enabled (most default terminals will be fine)
+
+## Usage
+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, 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 `~/.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 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 used is "shortcode,output"
+  2. Hidden shortcodes go above the line with "---"
+  3. Lines can be commented out using a "#"
+  4. Shortcodes may not contain a semicolon or a hyphen
+
+## License
+Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information