]> git.armaanb.net Git - charsel.git/blobdiff - README.md
removed MOTD, fixed german
[charsel.git] / README.md
index 9886a9f7c61892ec5f329f763d41d2681212e5fa..3f20e1f9b076fa39df87ed54edb86383be412659 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # CHARSEL
 # CHARSEL
-A very simple shell script to make copying frequently used special characters to your clipboard easy.
+A very simple bash script to make copying frequently used special characters to your clipboard easy.
 
 It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
 
 
 It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
 
@@ -8,12 +8,12 @@ Run `make install` as root to install
 Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
 ## Dependencies
 Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
 ## Dependencies
-  * Posix shell  
+  * bash
   * util-linux  
   * xclip  
   * A terminal with UTF-8 encoding enabled  
 
   * util-linux  
   * xclip  
   * A terminal with UTF-8 encoding enabled  
 
-## USAGE
+## Usage
 To start the program, run `charsel <charfile>`
 This will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`.
 
 To start the program, run `charsel <charfile>`
 This will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`.
 
@@ -21,15 +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.
 
 
 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 '---'
 
 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)
 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)
-
-## BRANCHES
-Development happens on the "development" branch, which then gets merged into the "main" branch once its ready for a stable release