X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;fp=README.md;h=a5444af257e7f0d8f5aae5c0a289cb8f64bc7c1f;hp=a3705005485140acc0c9c531e46c9d1789e65a22;hb=f91f2f2e9d218da186b0e84d1ad1a57632d3aebb;hpb=3175a81c8c551bb01af2dbc2737718dbb3ab0090 diff --git a/README.md b/README.md index a370500..a5444af 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,19 @@ It uses a plain-text file known as a "charfile" to define easy to reach shortcut ## Installation - Run `make install` as root to install - Run `make uninstall` as root to remove. Will not delete your personal charfiles -- Run `make purge` as a normal user to remove charsel files from your home directory +- Run `make purge` to remove charsel files from your home directory +- Run `make install-completions` to install the shell completions ## Dependencies * Bash * Linux * Xclip - * A terminal with UTF-8 encoding enabled + * A terminal with UTF-8 encoding enabled (most desktop environment's default terminal will be fine) ## Usage For argument usage, use `charsel -h` -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 +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, 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. @@ -26,9 +27,6 @@ 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