README: remove elaborate details from the intro
authorRan Benita <ran234@gmail.com>
Sat, 18 Oct 2014 10:58:56 +0000 (13:58 +0300)
committerRan Benita <ran234@gmail.com>
Sat, 18 Oct 2014 12:05:30 +0000 (15:05 +0300)
Point to the "quick guide" instead.

Signed-off-by: Ran Benita <ran234@gmail.com>
README.md

index 2d71d67..5e68e93 100644 (file)
--- 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