1.0 release!

[charsel.git] / README.md

diff --git a/README.md b/README.md
index d46893a61760fa48c9360d2e4e71582d8ffee944..e6849412424d7692a8cdcbe5ff257c6f1087a8b5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,36 @@
-A command line tool using xclip to copy special charachters. UTF-8 encoding required
+# CHARSEL
+A very simple shell 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
+Running the INSTALL.sh script should work fine for most people.
+
+If it is run as root or with sudo, the program and charfiles will be installed for all users. If it is run without elevated privileges, it will just be installed for the local user.
+
+## Dependencies
+  * Posix shell  
+  * util-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. If the charfile you used has multi-character shortcut keys, then you must hit enter after using a single letter shortcut. If the only shortcuts are single-letter, however, you can simply type the shortcut without clicking enter.
+
+The default charfiles all 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 '---'
+
+## 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)
+
+## BRANCHES
+Development happens on the "development" branch, which then gets merged into the "master" branch once its ready for a stable release