clarified creating a charfile

[charsel.git] / README.md

diff --git a/README.md b/README.md
index c4bd7c3842b81d8c4c95e4a5eab84b1e74be848a..b0f81dc084a4906e3fd7938da9b8bf8e31001f15 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,37 @@
-# 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.
-
-## DEPENDENCIES
-posix shell
-util-linux
-xclip
-
-## USAGE
-charselect.sh $charfile
+# 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 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 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 desktop environment's default terminal 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 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
+
+Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)