X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;h=b0f81dc084a4906e3fd7938da9b8bf8e31001f15;hp=a5444af257e7f0d8f5aae5c0a289cb8f64bc7c1f;hb=bc337195684eaeae2404a0aa5d2a533e89ea14da;hpb=f91f2f2e9d218da186b0e84d1ad1a57632d3aebb diff --git a/README.md b/README.md index a5444af..b0f81dc 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ It uses a plain-text file known as a "charfile" to define easy to reach shortcut ## Dependencies * Bash * Linux - * Xclip + * Xclip (using the -n flag bypasses this) * A terminal with UTF-8 encoding enabled (most desktop environment's default terminal will be fine) ## Usage @@ -23,9 +23,13 @@ Once you have started the program, simply type the shortcut listed on the left s 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 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. +Make a new file in `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` 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. ';' cannot be used as a shortcode, as that is used to quit the program +Fill in your shortcodes, using the provided examples in `/usr/share/charsel/charfiles` as a template. There are just 4 rules to follow. + 1. The pattern is "shortcode,output" + 2. Hidden shortcuts go above the line with '---' + 3. Lines can be commented out using a '#' at the start + 4. ";" cannot be used as a shortcode, as that is used to quit the program ## License Charfile is GNU GPLv3 licensed, see COPYING for more information