Improve the doc of the XKB keymap text format, V1 (#321)

[platform/upstream/libxkbcommon.git] / README.md

diff --git a/README.md b/README.md
index b8ae50d..4425578 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 libxkbcommon is a keyboard keymap compiler and support library which
 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.
 
 ## Quick Guide
 
@@ -15,6 +15,7 @@ libxkbcommon is built with [Meson](http://mesonbuild.com/):
 
     meson setup build
     ninja -C build
+    ninja -C build test  # Run the tests.
 
 To build for use with Wayland, you can disable X11 support while still
 using the X11 keyboard configuration resource files thusly:
@@ -58,16 +59,14 @@ xkbcommon is maintained in git at
 
 Patches are always welcome, and may be sent to either
     <xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
-or through github.
+or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request.
 
-Bug reports are also welcome, and may be filed either at
-    Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon
-or
-    Github https://github.com/xkbcommon/libxkbcommon/issues
+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