It works now! Still need to figuire out the correct directories and makefile for...

[charsel.git] / README.md

diff --git a/README.md b/README.md
index d46893a61760fa48c9360d2e4e71582d8ffee944..c4bd7c3842b81d8c4c95e4a5eab84b1e74be848a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,12 @@
-A command line tool using xclip to copy special charachters. UTF-8 encoding required
+# 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