From: Adrian Iain Lam <adrianiainlam@users.noreply.github.com>
Date: Mon, 19 Sep 2016 15:32:28 +0000 (+0800)
Subject: Update README to state >= GTK+ 3.18 dependency...
X-Git-Tag: v0.99~1
X-Git-Url: https://adrianiainlam.tk/git/?a=commitdiff_plain;h=73e49461ee1d4ad9869b957f5b9d72f87ecb2ca3;p=indicator-keyboard-led.git

Update README to state >= GTK+ 3.18 dependency...

... for get_scroll_lock_state. Reported in #1.
---

diff --git a/README.md b/README.md
index 111d461..e8f123c 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,13 @@ distributions. To install the rest, run:
 
     sudo apt-get install python3-gi xdotool
 
+**Note**: [`gdk_keymap_get_scroll_lock_state ()`][gtkdoc-scroll] is only
+available since GTK+ 3.18. The earliest Ubuntu release that supports
+GTK+ 3.18 is 16.04 (Xenial). This means that if you use an older version
+you will have to ignore Scroll lock functionality (See [Examples](#examples)).
+
+[gtkdoc-scroll]: https://developer.gnome.org/gdk3/stable/gdk3-Keyboard-Handling.html#gdk-keymap-get-scroll-lock-state
+
 ## Usage
 
  1. Install the dependencies listed above.
@@ -79,6 +86,8 @@ Default appearance in a French locale.
 
 ## Known bugs
 
+### Pressing Scroll Lock does nothing
+
 It seems to be a common problem that Scroll Lock is not usable in Ubuntu.
 To solve this, do the following (assuming US keyboard):
 
@@ -110,6 +119,16 @@ modified. [Original source][origsrc] by dm+ on PCLinuxOS-Forums.
 [origsrc]: http://www.pclinuxos.com/forum/index.php/topic,125690.msg1052201.html?PHPSESSID=2qsv83lve6dgd0ivq14bfcjc30#msg1052201
 [quotesrc]: http://askubuntu.com/a/597757/274080
 
+### X11Keymap has no attribute 'get_scroll_lock_state'
+
+If running the script gives the error message
+
+    AttributeError: 'gtk.gdk.X11Keymap' object has no attribute 'get_scroll_lock_state'
+
+then your installed GTK+ version is probably older than 3.18, which
+does not support `get_scroll_lock_state`. Either hide all Scroll Lock
+functionality (See [Examples](#examples)), or upgrade your system.
+
 ## Localization
 
 As motivated by Issue #1, this script has been localized to French (with