diff options
author | Ran Benita <ran234@gmail.com> | 2014-10-18 13:58:56 +0300 |
---|---|---|
committer | Ran Benita <ran234@gmail.com> | 2014-10-18 15:05:30 +0300 |
commit | bac0c323b6559e37af04c4d6c8eb118d926ce07c (patch) | |
tree | 3f5f5698a3c2af5bf1a7b874ea5fd4799b0e5c26 /README.md | |
parent | ab9cb11c91d5d9041de7f198f30bca3f7470ac6b (diff) | |
download | xorg-lib-libxkbcommon-bac0c323b6559e37af04c4d6c8eb118d926ce07c.tar.gz |
README: remove elaborate details from the intro
Point to the "quick guide" instead.
Signed-off-by: Ran Benita <ran234@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 2 insertions, 11 deletions
@@ -1,16 +1,7 @@ # libxkbcommon -xkbcommon is a keymap compiler and support library which processes a -reduced subset of keymaps as defined by the XKB specification. Primarily, -a keymap is created from a set of Rules/Model/Layout/Variant/Options names, -processed through an XKB ruleset, and compiled into a struct xkb_keymap, -which is the base type for all xkbcommon operations. - -From an xkb_keymap, an xkb_state object is created which holds the current -state of all modifiers, groups, LEDs, etc, relating to that keymap. All -key events must be fed into the xkb_state object using xkb_state_update_key(). -Once this is done, the xkb_state object will be properly updated, and the -keysyms to use can be obtained with xkb_state_key_get_syms(). +libxkbcommon is a keymap compiler and support library which processes a +reduced subset of keymaps as defined by the XKB specification. ## Quick Guide |