README: stop pointing at bugs.freedesktop.org
[platform/upstream/libxkbcommon.git] / README.md
1 # libxkbcommon
2
3 libxkbcommon is a keyboard keymap compiler and support library which
4 processes a reduced subset of keymaps as defined by the XKB (X Keyboard
5 Extension) specification.  It also contains a module for handling Compose
6 and dead keys.
7
8 ## Quick Guide
9
10 See [Quick Guide](doc/quick-guide.md).
11
12 ## Building
13
14 libxkbcommon is built with [Meson](http://mesonbuild.com/):
15
16     meson setup build
17     ninja -C build
18
19 To build for use with Wayland, you can disable X11 support while still
20 using the X11 keyboard configuration resource files thusly:
21
22     meson setup build \
23         -Denable-x11=false \
24         -Dxkb-config-root=/usr/share/X11/xkb \
25         -Dx-locale-root=/usr/share/X11/locale
26     ninja -C build
27
28 ## API
29
30 While libxkbcommon's API is somewhat derived from the classic XKB API as found
31 in X11/extensions/XKB.h and friends, it has been substantially reworked to
32 expose fewer internal details to clients.
33
34 See the [API Documentation](https://xkbcommon.org/doc/current/modules.html).
35
36 ## Dataset
37
38 libxkbcommon does not distribute a keymap dataset itself, other than for
39 testing purposes.  The most common dataset is xkeyboard-config, which is used
40 by all current distributions for their X11 XKB data.  More information on
41 xkeyboard-config is available here:
42     https://www.freedesktop.org/wiki/Software/XKeyboardConfig
43
44 The dataset for Compose is distributed in libX11, as part of the X locale
45 data.
46
47 ## Relation to X11
48
49 See [Compatibility](doc/compat.md) notes.
50
51 ## Development
52
53 An extremely rudimentary homepage can be found at
54     https://xkbcommon.org
55
56 xkbcommon is maintained in git at
57     https://github.com/xkbcommon/libxkbcommon
58
59 Patches are always welcome, and may be sent to either
60     <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
61 or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.
62
63 Bug reports are also welcome, and may be filed at
64 [GitHub](https://github.com/xkbcommon/libxkbcommon/issues).
65
66 The maintainers are
67 - Daniel Stone <daniel@fooishbar.org>
68 - Ran Benita <ran234@gmail.com>
69
70 ## Credits
71
72 Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
73 off the ground initially.