From fc664cf1cc8c1cccd6137134cf5018d8fc9b1ca5 Mon Sep 17 00:00:00 2001 From: Pierre Le Marre Date: Sat, 13 May 2023 05:30:11 +0200 Subject: Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 84bbcaa..b36e3cf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ # libxkbcommon libxkbcommon is a keyboard keymap compiler and support library which -processes a reduced subset of keymaps as defined by the XKB (X Keyboard +processes a reduced subset of keymaps as defined by the [XKB] \(X Keyboard Extension) specification. It also contains a module for handling Compose and dead keys and a separate library for listing available keyboard layouts. +[XKB]: doc/introduction-to-xkb.md + ## Quick Guide -See [Quick Guide](doc/quick-guide.md). +See [Introduction to XKB][XKB] to learn the essentials of XKB. + +See [Quick Guide](doc/quick-guide.md) for an introduction on how to use this +library. ## Building @@ -29,7 +34,7 @@ using the X11 keyboard configuration resource files thusly: ## API While libxkbcommon's API is somewhat derived from the classic XKB API as found -in X11/extensions/XKB.h and friends, it has been substantially reworked to +in `X11/extensions/XKB.h` and friends, it has been substantially reworked to expose fewer internal details to clients. See the [API Documentation](https://xkbcommon.org/doc/current/modules.html). @@ -47,7 +52,7 @@ data. ## Relation to X11 -See [Compatibility](doc/compat.md) notes. +See [Compatibility](doc/compatibility.md) notes. ## Development -- cgit v1.2.1