summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRan Benita <ran234@gmail.com>2014-10-18 13:58:56 +0300
committerRan Benita <ran234@gmail.com>2014-10-18 15:05:30 +0300
commitbac0c323b6559e37af04c4d6c8eb118d926ce07c (patch)
tree3f5f5698a3c2af5bf1a7b874ea5fd4799b0e5c26
parentab9cb11c91d5d9041de7f198f30bca3f7470ac6b (diff)
downloadxorg-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>
-rw-r--r--README.md13
1 files changed, 2 insertions, 11 deletions
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