README.md


Log

Author Commit Date CI Message
Pierre Le Marre fc664cf1 2023-05-13T05:30:11 Improve documentation - Add introduction to XKB - Embrace Doxygen features - More cross links
Peter Hutterer 98b33142 2023-05-04T20:35:39 README: use meson compile/test over ninja This is backend-agnostic and the recommended way to invoke compilation. This requires meson 0.55 (July 2020) and we only require 0.51 but at this point I'm expecting most users who require the README instructions will have a recent-enough meson anyway.
matthickford 2e571b43 2021-10-11T18:30:31 Add instructions to run tests. Add build/ to .gitignore.
M Hickford 9bbe629a 2021-12-23T12:58:06 Update README.md Co-authored-by: Ran Benita <ran@unusedvar.com>
Peter Hutterer afb26e7d 2020-05-12T14:09:50 Add libxkbregistry to query available RMLVO This library is the replacement for clients parsing evdev.xml directly. Instead, they should use the API here so that in the future we may even be able to swap evdev.xml for a more suitable data format. The library parses through evdev.xml (using libxml2) and - if requested - through evdev.extras.xml as well. The merge approach is optimised for the default case where we have a system-installed rules XML and another file in $XDG_CONFIG_DIR that adds a few entries. We load the system file first, then append any custom ones to that. It's not possible to overwrite the MLVO list provided by the system files - if you want to do that, get the change upstream. XML validation is handled through the DTD itself which means we only need to check for a nonempty name, everything else the DTD validation should complain about. The logging system is effectively identical to xkbcommon. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Ran Benita aa118b4b 2019-10-19T00:55:21 README: update my email address Signed-off-by: Ran Benita <ran@unusedvar.com>
Ran Benita 255047f7 2019-02-26T18:27:53 README: usage questions are alright Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 6f0f9534 2019-02-26T18:26:01 README: stop pointing at bugs.freedesktop.org No-one filed bugs in there for a while, let's consolidate on the more popular one. Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 767fa86d 2017-12-21T14:18:07 Convert http:// -> https:// where possible Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 8ce81c06 2017-12-15T16:17:45 README,PACKAGING: use the new meson unified command format Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 86434d84 2017-07-25T21:57:42 build: add meson build system Meson is easier to maintain, much faster, encourages better practices, and is not built on a pile of shell scripts. The autotools build system is kept intact for now, in order to ease the migration. The intention is to remove it sooner rather than later, if all goes well. Run `meson build && mesonconf build` to see the configuration options for the new system. Conversion should be straightforward. Environment variables like CFLAGS work the same. If meson is used, xorg-util-macros is not required. In terms of functionality the two systems have about the same capabilities. Here are some differences I noticed: - Meson uses `-g` by default, autotools uses `-g -O2`. - In autotools the default behavior is to install both static and shared versions of the libraries. In meson the user must choose exactly one (using -Ddefault_library=static/shared). It is possible to workaround if needed (install twice...), but hopefully meson will add the option in the future. - Autotools has builtin ctags/cscope targets, meson doesn't. Easy to run the tools directly. - Meson has builtin benchmarks target. Handy. - Meson has builtin support for sanitizers/clang-analyzer/lto/pgo/ coverage etc. Also handy. Signed-off-by: Ran Benita <ran234@gmail.com>
Bryce Harrington af2c83b6 2016-09-15T14:31:55 README: Add basic build directions In particular, highlight the use of configure flags to control locating X11 keyboard stuff when building for Wayland. Of particular note, if the locale root is not specified, then xkbcommon will look for them under $prefix (i.e. /usr/local/share/X11/locale). But unless the user has specifically installed them there, it is better to look in the standard system location, /usr/share/X11/locale. Otherwise, xkbcommon will error when it can't find them, e.g.: xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Ran Benita <ran234@gmail.com>
Bryce Harrington e92e0b88 2016-09-15T14:31:54 README: Bug *reports* are welcome Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Yong Bakos <ybakos@humanoriented.com> Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 6337d789 2014-10-18T14:52:54 README: we also accepts patches through github Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita b05a05ed 2014-10-18T14:29:37 README: add notes about Compose support Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita bac0c323 2014-10-18T13:58:56 README: remove elaborate details from the intro Point to the "quick guide" instead. Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 494a8fbf 2014-10-18T13:50:54 README: move compatibility notes to their own page Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 2e8ab383 2014-10-18T13:44:02 README: link to online API docs Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita cb461893 2014-10-18T13:34:15 README: move note about xkeyboard-config to its own section Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 8bf1e193 2014-10-18T13:31:32 README: remove section on API stability This was useful when we *weren't* stable. But now that we are this should be obvious. Signed-off-by: Ran Benita <ran234@gmail.com>
Ran Benita 806dbeac 2014-03-23T15:04:51 Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>