X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=b36e3cf005c7b04b5d7ff35a969f918b0ffb8a0c;hb=a83d745b62ea8ec89e939b00bb3754ad54280942;hp=73950dd0e9adc3a63cdc2d9294eee052f9a8d3bf;hpb=6f0f9534b32972a9dbaa8ac8262966949b69de98;p=platform%2Fupstream%2Flibxkbcommon.git

diff --git a/README.md b/README.md
index 73950dd..b36e3cf 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,26 @@
 # 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 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
 
 libxkbcommon is built with [Meson](http://mesonbuild.com/):
 
     meson setup build
-    ninja -C build
+    meson compile -C build
+    meson test -C build # Run the tests.
 
 To build for use with Wayland, you can disable X11 support while still
 using the X11 keyboard configuration resource files thusly:
@@ -23,12 +29,12 @@ using the X11 keyboard configuration resource files thusly:
         -Denable-x11=false \
         -Dxkb-config-root=/usr/share/X11/xkb \
         -Dx-locale-root=/usr/share/X11/locale
-    ninja -C build
+    meson compile -C build
 
 ## 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).
@@ -46,7 +52,7 @@ data.
 
 ## Relation to X11
 
-See [Compatibility](doc/compat.md) notes.
+See [Compatibility](doc/compatibility.md) notes.
 
 ## Development
 
@@ -60,12 +66,12 @@ Patches are always welcome, and may be sent to either
     <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
 or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.
 
-Bug reports are also welcome, and may be filed at
+Bug reports (and usage questions) are also welcome, and may be filed at
 [GitHub](https://github.com/xkbcommon/libxkbcommon/issues).
 
 The maintainers are
 - Daniel Stone <daniel@fooishbar.org>
-- Ran Benita <ran234@gmail.com>
+- Ran Benita <ran@unusedvar.com>
 
 ## Credits