Commit Graph

21 Commits (d2a08f761c796733e42fac4099f5c38d443e88e1)

Author SHA1 Message Date
Pierre Le Marre fc664cf1cc Improve documentation
- Add introduction to XKB
- Embrace Doxygen features
- More cross links
2023-05-13 22:05:23 +03:00
Peter Hutterer 98b3314278 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.
2023-05-05 09:44:56 +10:00
M Hickford 9bbe629aad Update README.md
Co-authored-by: Ran Benita <ran@unusedvar.com>
2022-01-11 16:49:22 +02:00
matthickford 2e571b4392 Add instructions to run tests. Add build/ to .gitignore. 2022-01-11 16:49:22 +02:00
Peter Hutterer afb26e7df9 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>
2020-07-06 15:15:20 +10:00
Ran Benita aa118b4b97 README: update my email address
Signed-off-by: Ran Benita <ran@unusedvar.com>
2019-10-19 00:55:21 +03:00
Ran Benita 255047f757 README: usage questions are alright
Signed-off-by: Ran Benita <ran234@gmail.com>
2019-02-26 18:32:32 +02:00
Ran Benita 6f0f9534b3 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>
2019-02-26 18:32:32 +02:00
Ran Benita 767fa86d42 Convert http:// -> https:// where possible
Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-21 14:18:07 +02:00
Ran Benita 8ce81c0607 README,PACKAGING: use the new meson unified command format
Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-15 16:18:14 +02:00
Ran Benita 86434d8498 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>
2017-07-31 20:53:39 +03:00
Bryce Harrington af2c83b664 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>
2016-09-16 09:24:09 +03:00
Bryce Harrington e92e0b88c6 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>
2016-09-16 09:24:04 +03:00
Ran Benita 6337d789e6 README: we also accepts patches through github
Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 15:06:16 +03:00
Ran Benita b05a05edbd README: add notes about Compose support
Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 15:05:30 +03:00
Ran Benita bac0c323b6 README: remove elaborate details from the intro
Point to the "quick guide" instead.

Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 15:05:30 +03:00
Ran Benita 494a8fbf3f README: move compatibility notes to their own page
Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 15:05:30 +03:00
Ran Benita 2e8ab38351 README: link to online API docs
Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 14:12:45 +03:00
Ran Benita cb46189335 README: move note about xkeyboard-config to its own section
Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 13:34:15 +03:00
Ran Benita 8bf1e193fc 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>
2014-10-18 13:31:32 +03:00
Ran Benita 806dbeac81 Reformat README markdown
So that github displays it as markdown, and correctly.

Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-27 17:11:49 +02:00