Merge branch 'master' of https://github.com/limbo666/KeyzPal

README.md

@@ -1,6 +1,6 @@
-# **KeyzPal**
-![alt text](https://github.com/limbo666/KeyzPal/blob/master/additional_files/KeyzPal_Key_Logo_1.png)
+# **KeyzPal** ![version](https://img.shields.io/github/v/tag/limbo666/keyzpal) [![Github All Releases](https://img.shields.io/github/downloads/limbo666/KeyzPal/total.svg)]()  ![alt text](https://img.shields.io/github/last-commit/limbo666/keyzpal/master)
 
+![alt text](https://github.com/limbo666/KeyzPal/blob/master/additional_files/KeyzPal_Key_Logo_1.png)
 KeyzPal is a Windows tray utility to indicate the **CAPS**, **NUM** and **SCROLL** key status. 
 
 
@@ -15,28 +15,53 @@ The program currently offers:
 
 - *Easy to use interface.*
 
-- *Keys normalization function.*
-
 - *Selectable icon sets.*  
 
-- *Selectable sound on normalization.*  
+- *Keys normalization function.*
 
 - *Selectable keys normal state for normalization.*   
 
+- *Selectable sounds! Triggered on key normalization and/or on lock key press.*
+
+- *On screen notifications.*
+
+- *Conditional CAPS LOCK function.* 
+
 
 
-Normalization function: 
+## Keys normalization function: 
+This function can set the lock keys state to "normal" after a selectable period of time. From version 1.0.3.8 the program can detect key presses on the keyboard and reset the remaining time each time a key is pressed. This way the program will normalize the keys only if the system is inactive for the predefined time.<br/> 
 
-This function can set the lock keys state to "normal" after a selectable period of time. From version 1.0.3.8 the program can detect key presses on the keyboard and reset the remaining time each time a key is pressed. This way the program will normalize the keys only if the system is inactive for the predefined time. 
+From version 1.0.4.11 the keys normal state can be selected by the user under settings.
 
-From version 1.0.4.11 the keys norma state can be selected by the user under settings.
 
-## GUI
+## Conditional CAPS LOCK function (beta): 
+This function can be used to auto switch on (or off) CAPS LOCK dependind on the current active window. Up to 10 program titles per fucntion can be predifined on file lists.ini.<br/>
+This file should be places in the same folder with `keyzpal.exe`. Its contents will be readed upon program launch.<br/> A part of the target window title should be enough to auto switch to predifined CAPS lock. <br/>
+<br/>
+Examples how to use: <br/>
+If is needed to have CAPS LOCK switched on each time NOTEPAD++ is selected, the keyword `Notepad++` should be added to one of the "UpperCase" lines on `lists.ini` file.<br/>
+If is needed to have CAPS LOCK switched on each time a specific textfile (let's say `mydailynotes.txt`) is edited on NOTEPAD++ (or any other editor), the keyword `mydailynotes.txt` or the keyword `mydailynotes` should be added to one of the "UpperCase" lines on `lists.ini` file.<br/>
 
+The keywords should be as much unique as possible to distinguish each window and avoid unnecessary CAPS LOCK forcing.<br/>
+An example `lists.ini` file can be downloaded from [properties folder](https://github.com/limbo666/KeyzPal/blob/master/Properties/)<br/>
+
+
+## GUI
 ![](https://github.com/limbo666/KeyzPal/blob/master/additional_files/gui_1.png?raw=true)
 
 The GUI is simple and self explained. Once you are execute and configure it, the program will run silently on you system tray indicating the status of lock keys.
 
 ## Download 
+You can get the latest executable from releases page: https://github.com/limbo666/KeyzPal/releases <br>
+
+## Installation 
+Installation is not needed. Unzip contents to a folder on your disk (e.g. C:\Tools\KeyzPal) and run the executable.<br>
+If you want to use the conditional caps function you should place the `lists.ini` file in the same folder with the `keyzpal.exe`. Download `lists.ini` from [properties folder](https://github.com/limbo666/KeyzPal/blob/master/Properties/)
+
+
+## Compiling
+Visual Studio is needed to work with the code. The current code is created using VS 2019 and  VS 2022 should be compatible as well.<br>  For VS downloading you can refer to [MS](https://visualstudio.microsoft.com/downloads/). Free (Community) edition of VS can be used.
+
+
 
-You can get the latest executable from releases page: https://github.com/limbo666/KeyzPal/releases