X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=README.md;h=74d1d27947154a91fe774fb7ef26df96a977b2c4;hb=abb115c78faeb09b6f74ae9811b986f155f7fad7;hp=9aab641db57db88c5e4acf61ba57e65044493c7d;hpb=86434d8498fdc674a8b1c9fe7f9f4b4ca54240a5;p=platform%2Fupstream%2Flibxkbcommon.git diff --git a/README.md b/README.md index 9aab641..74d1d27 100644 --- 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 @@ -13,13 +13,13 @@ See [Quick Guide](doc/quick-guide.md). libxkbcommon is built with [Meson](http://mesonbuild.com/): - meson build + meson setup build ninja -C build To build for use with Wayland, you can disable X11 support while still using the X11 keyboard configuration resource files thusly: - meson build \ + meson setup build \ -Denable-x11=false \ -Dxkb-config-root=/usr/share/X11/xkb \ -Dx-locale-root=/usr/share/X11/locale @@ -31,7 +31,7 @@ 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 expose fewer internal details to clients. -See the [API Documentation](http://xkbcommon.org/doc/current/modules.html). +See the [API Documentation](https://xkbcommon.org/doc/current/modules.html). ## Dataset @@ -39,7 +39,7 @@ libxkbcommon does not distribute a keymap dataset itself, other than for testing purposes. The most common dataset is xkeyboard-config, which is used by all current distributions for their X11 XKB data. More information on xkeyboard-config is available here: - http://www.freedesktop.org/wiki/Software/XKeyboardConfig + https://www.freedesktop.org/wiki/Software/XKeyboardConfig The dataset for Compose is distributed in libX11, as part of the X locale data. @@ -51,23 +51,21 @@ See [Compatibility](doc/compat.md) notes. ## Development An extremely rudimentary homepage can be found at - http://xkbcommon.org + https://xkbcommon.org xkbcommon is maintained in git at https://github.com/xkbcommon/libxkbcommon Patches are always welcome, and may be sent to either or -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 -- Ran Benita +- Ran Benita ## Credits