check for xclip

[charsel.git] / README.md

diff --git a/README.md b/README.md
index d46893a61760fa48c9360d2e4e71582d8ffee944..7ee46b1c049c2f4fc7c28960e9a182b9970ffd49 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
-A command line tool using xclip to copy special charachters. UTF-8 encoding required
+# 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.
+
+## Installation
+Run `make install` as root to install  
+Run `make uninstall` as root to remove. Will not delete your personal charfiles
+
+## Dependencies
+  * Bash
+  * Linux  
+  * Xclip  
+  * A terminal with UTF-8 encoding enabled  
+
+## Usage
+To start the program, run `charsel <charfile>`, this will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`.
+
+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.
+
+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/` or `/usr/share/charsel` 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
+
+## 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)