X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;h=a356335653d7f8d2c954ac53532ed6ffbac8d6c8;hp=295998dcac59bf9c4b41e8236fbb2513dac3e778;hb=fbbee478d81f974898259ba4307c1660fe72758d;hpb=76db80f5cf647e9aa47cd1404e7acd5107166dfb diff --git a/README.md b/README.md index 295998d..a356335 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,14 @@ Run `make uninstall` as root to remove. Will not delete your personal charfiles * A terminal with UTF-8 encoding enabled ## Usage -For usage, use `charsel --help` +For usage, use `charsel -h` 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. ## 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. +Make a new file in the `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` directories 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