From: Armaan Bhojwani <3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me> Date: Thu, 15 Oct 2020 17:20:31 +0000 (-0400) Subject: Updated md X-Git-Url: https://git.armaanb.net/?p=charsel.git;a=commitdiff_plain;h=70a3613ebba8fe0c131a2ca600d77776a8ef946d Updated md --- diff --git a/README.md b/README.md index 0d3f765..3f20e1f 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Run `make uninstall` as root to remove. Will not delete your personal charfiles * xclip * A terminal with UTF-8 encoding enabled -## USAGE +## Usage To start the program, run `charsel ` This will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`. @@ -21,12 +21,12 @@ Once you have started the program, simply type the shortcut listed on the left s The default charfiles all 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 +## Creating a charfile Make a new file in `~/.local/share/charsel/` or `/usr/share/charsel` 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 '---' -## LICENSE +## License Charfile is GNU GPLv3 licensed, see COPYING for more information Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me) diff --git a/todo.md b/todo.md new file mode 100644 index 0000000..8cb5151 --- /dev/null +++ b/todo.md @@ -0,0 +1,2 @@ +[] Create a simple gtk interface using Zenity +[] Cleanup code