X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=blobdiff_plain;f=README.md;h=6ce415bf63f59fe0629b3a6bc02ff2a4f07f753b;hp=c4bd7c3842b81d8c4c95e4a5eab84b1e74be848a;hb=1513db21226acbb1d8bc830f8b952c56ba123de8;hpb=17650c88e5d801efa2142c13e2f029d358160245 diff --git a/README.md b/README.md index c4bd7c3..6ce415b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # charsel A very simple comand line tool to make a shortcut to a special characther. -It takes the input of a .char file, 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. -A .char file is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied. + +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. + +A charfile is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied. + +## INSTALLATION +Run the INSTALL.sh script +If run as root, it will be installed globally, if run without root, it will be just instaled for the local user ## DEPENDENCIES posix shell @@ -9,4 +15,8 @@ util-linux xclip ## USAGE -charselect.sh $charfile +charsel + +## CREATING A CHARFILE +Make a new file in ~/.local/share/charsel/ with the name that you want to use to call the file in the command +Fill it in, using the provided example as a template.