README.md

   1 # libxkbcommon
   2
   3 libxkbcommon is a keymap compiler and support library which processes a
   4 reduced subset of keymaps as defined by the XKB specification.
   5
   6 ## Quick Guide
   7
   8 See [Quick Guide](doc/quick-guide.md).
   9
  10 ## API
  11
  12 While libxkbcommon's API is somewhat derived from the classic XKB API as found
  13 in X11/extensions/XKB.h and friends, it has been substantially reworked to
  14 expose fewer internal details to clients.
  15
  16 See the [API Documentation](http://xkbcommon.org/doc/current/modules.html).
  17
  18 ## Dataset
  19
  20 libxkbcommon does not distribute a keymap dataset itself, other than for
  21 testing purposes.  The most common dataset is xkeyboard-config, which is used
  22 by all current distributions for their X11 XKB data.  More information on
  23 xkeyboard-config is available here:
  24     http://www.freedesktop.org/wiki/Software/XKeyboardConfig
  25
  26 ## Relation to X11
  27
  28 See [Compatibility](doc/compat.md) notes.
  29
  30 ## Development
  31
  32 An extremely rudimentary homepage can be found at
  33     http://xkbcommon.org
  34
  35 xkbcommon is maintained in git at
  36     https://github.com/xkbcommon/libxkbcommon
  37
  38 Patches are always welcome, and may be sent to either
  39     <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
  40
  41 Bugs are also welcome, and may be reported either at
  42     Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon
  43 or
  44     Github https://github.com/xkbcommon/libxkbcommon/issues
  45
  46 The maintainers are
  47 - Daniel Stone <daniel@fooishbar.org>
  48 - Ran Benita <ran234@gmail.com>
  49
  50 ## Credits
  51
  52 Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
  53 off the ground initially.