StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: remove elaborate details from the intro 

Point to the "quick guide" instead.

Signed-off-by: Ran Benita <ran234@gmail.com>
master
Ran Benita 2014-10-18 13:58:56 +03:00
parent ab9cb11c91
commit bac0c323b6
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,16 +1,7 @@
# libxkbcommon # libxkbcommon
xkbcommon is a keymap compiler and support library which processes a libxkbcommon is a keymap compiler and support library which processes a
reduced subset of keymaps as defined by the XKB specification. Primarily, reduced subset of keymaps as defined by the XKB specification.
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().
## Quick Guide ## Quick Guide