README.md

   1 # CHARSEL
   2 A simple bash script to make copying frequently used special characters to your clipboard easy.
   3
   4 It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
   5
   6 ## Installation
   7 - Run `make install` as root to install
   8 - Run `make uninstall` as root to remove. Will not delete your personal charfiles
   9 - Run `make purge` as a normal user to remove charsel files from your home directory
  10
  11 ## Dependencies
  12   * Bash
  13   * Linux
  14   * Xclip
  15   * A terminal with UTF-8 encoding enabled
  16
  17 ## Usage
  18 For argument usage, use `charsel -h`
  19
  20 This script is also so simple that the script itself can basically function as the documentation
  21
  22 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
  23
  24 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.
  25
  26 ## Creating a charfile
  27 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.
  28
  29 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
  30
  31 ## License
  32 Charfile is GNU GPLv3 licensed, see COPYING for more information
  33
  34 Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)