removed MOTD, fixed german

[charsel.git] / README.md

diff --git a/README.md b/README.md
index 6ce415bf63f59fe0629b3a6bc02ff2a4f07f753b..3f20e1f9b076fa39df87ed54edb86383be412659 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,32 @@
-# charsel
-A very simple comand line tool to make a shortcut to a special characther. 
+# CHARSEL
+A very simple bash script to make copying frequently used special characters to your clipboard easy.
 
-It takes the input of a charfile, 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.
+It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
 
-A charfile is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
+## Installation
+Run `make install` as root to install  
+Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
-## INSTALLATION
-Run the INSTALL.sh script
-If run as root, it will be installed globally, if run without root, it will be just instaled for the local user
+## Dependencies
+  * bash
+  * util-linux  
+  * xclip  
+  * A terminal with UTF-8 encoding enabled  
 
-## DEPENDENCIES
-posix shell
-util-linux
-xclip
+## 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`.
 
-## USAGE
-charsel <charfile>
+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.
 
-## CREATING A CHARFILE
-Make a new file in ~/.local/share/charsel/ with the name that you want to use to call the file in the command
-Fill it in, using the provided example as a template.
+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)