From bac0c323b6559e37af04c4d6c8eb118d926ce07c Mon Sep 17 00:00:00 2001 From: Ran Benita Date: Sat, 18 Oct 2014 13:58:56 +0300 Subject: README: remove elaborate details from the intro Point to the "quick guide" instead. Signed-off-by: Ran Benita --- README.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2d71d67..5e68e93 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.1