aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexis Maiquez Murcia <almamu@almamu.com>2019-02-20 09:57:51 +0100
committerAlexis Maiquez Murcia <almamu@almamu.com>2019-02-20 09:57:51 +0100
commit959357b391dc5d561788f50d0b84ddc11fefd478 (patch)
treee4061246005f71644512f4ff6402a34814816faf /README.md
parentd843e6a66a11e07595c8c4964fb8a1d343172990 (diff)
downloadlead-959357b391dc5d561788f50d0b84ddc11fefd478.tar
lead-959357b391dc5d561788f50d0b84ddc11fefd478.tar.gz
lead-959357b391dc5d561788f50d0b84ddc11fefd478.zip
Added debug mode
This allows the user to display the screen names, the sensors activated and the status of those sensors: red -> waiting for mouse to enter yellow -> waiting for delay timer to reach 0 green -> fired the command Signed-off-by: Alexis Maiquez Murcia <almamu@almamu.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 790ec39..75d2085 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,9 @@
This fork adds support for specifying an interval to wait before the action is triggered. There may be more improvements in the future.
-![Screenshot of lead](https://github.com/mlde/lead/blob/master/screenshot.png)
-> Despite the screenshot, the sensors are only 1px in size and invisible.
+![Screenshot of lead](https://github.com/almamu/lead/blob/master/screenshots/screenshot1.png)
+![Screenshot of lead](https://github.com/almamu/lead/blob/master/screenshots/screenshot2.png)
+> Sensors are not displayed unless the debug mode is enabled
### Features
@@ -75,6 +76,16 @@ Sensors have their own sections in the configuration, so if you want to add an a
Delays are configured in miliseconds and dictate the amount of time the mouse has to be in the sensor to trigger the specific action.
In the case of exitDelay, this delay affects how much time the mouse has to be in the sensor for it to trigger the exitAction when the mouse moves out of the sensor.
+If you are not sure why a sensor isn't properly firing you can enable the debug mode to visualize what their position is, your screen names and the status they're in.
+Each configured sensor will be displayed in a red color when the sensor is waiting for the mouse to enter it.
+Once the mouse is in, the sensor will turn to yellow, this indicates that it is waiting for the enter delay timer to end. Once the timer ends the sensor will turn green and the program should be run.
+If still your program doesn't run please check lead's output to get a better idea of what's happening.
+
+In debug mode the screen names are shown on the top-left corner of each screen.
+To enable the debug mode add the following section in the config file:
+ [systemsettings]
+ debug=1
+
The configuration file is monitored and changes are applied automatically.