X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;fp=README.md;h=a3705005485140acc0c9c531e46c9d1789e65a22;hp=a9f84b8d852463c1682164e9046f61d939de3df9;hb=3175a81c8c551bb01af2dbc2737718dbb3ab0090;hpb=74601c376caedf65d541ab67e63513448a9bd7ec diff --git a/README.md b/README.md index a9f84b8..a370500 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,6 @@ It uses a plain-text file known as a "charfile" to define easy to reach shortcut ## Usage For argument usage, use `charsel -h` -This script is also so simple that the script itself can basically function as the documentation - Once you [have](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, type ';' as a shortcode 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. @@ -28,6 +26,9 @@ Make a new file in the `~/.local/share/charsel/charfiles/` or `/usr/share/charse 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. ';' cannot be used as a shortcode, as that is used to quit the program +## Shell completions +There is a shell completion script provided. To install it, use `make install-completions` + ## License Charfile is GNU GPLv3 licensed, see COPYING for more information