X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;h=295998dcac59bf9c4b41e8236fbb2513dac3e778;hp=7ee46b1c049c2f4fc7c28960e9a182b9970ffd49;hb=76db80f5cf647e9aa47cd1404e7acd5107166dfb;hpb=964160e6b899f5074aec9a23faaf176df38bbbbd diff --git a/README.md b/README.md index 7ee46b1..295998d 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,19 @@ A simple bash script to make copying frequently used special characters to your 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 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 + * Linux + * Xclip + * A terminal with UTF-8 encoding enabled ## Usage -To start the program, run `charsel `, this will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`. +For usage, use `charsel --help` -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. +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, use ^C 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. @@ -27,5 +27,5 @@ Fill it in, using the provided examples as a template. Hidden shortcuts go above ## 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)