]> git.armaanb.net Git - charsel.git/blob - README.md
Small changes to improve usability
[charsel.git] / README.md
1 # charsel
2 A very simple comand line tool to make a shortcut to a special characther. 
3
4 It takes the input of a charfile, then puts it into a table and waits for your input. Once you put in your shortcut key, it prints the special character then copies it to the clipboard.
5
6 A charfile is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
7
8 ## INSTALLATION
9 Run the INSTALL.sh script
10 If run as root, it will be installed globally, if run without root, it will be just instaled for the local user
11
12 ## DEPENDENCIES
13 posix shell
14 util-linux
15 xclip
16
17 ## USAGE
18 charsel <charfile>
19
20 ## CREATING A CHARFILE
21 Make a new file in ~/.local/share/charsel/ with the name that you want to use to call the file in the command
22 Fill it in, using the provided example as a template.