From dc43b04767f797f0e55f4d1cffd1cb696c75bb15 Mon Sep 17 00:00:00 2001 From: gered Date: Mon, 30 Nov 2015 15:06:38 -0500 Subject: [PATCH] update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index b5ee2e7..ea0b448 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,19 @@ $ gradle shadowJar Which will spit out an "uber JAR" under `build/libs` under the naming convention `llanfair-[VERSION]-all.jar`. +## Mac OS X and Accessibility Settings for Global Hotkeys + +Previous releases of Llanfair used an older version of JNativeHook which didn't really provide any built-in help +if OS X was not properly configured in advance when Llanfair tried to hook into global key events. This version +uses a more recent version that pops up a dialog telling you what to do if Llanfair does not yet have the required +accessibility permissions, so you should not get the problem where Llanfair mysteriously closes immediately after +running. + +Note that currently Llanfair **only** supports hotkeys via the JNativeHook / global hotkey interface! If it was not +able to hook into the OS's key events (either because you denied proper permissions or for some other reason), then +you will not be able to set any hotkeys in the settings window and you will thusly not be able to trigger any splits or +start/stop any runs! This is one of the first things I intend to address. + ## TODO Lots of stuff still to be done. :)