summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Improve documentationPierre Le Marre2023-05-131-4/+9
| | | | | | - Add introduction to XKB - Embrace Doxygen features - More cross links
* README: use meson compile/test over ninjaPeter Hutterer2023-05-051-3/+3
| | | | | | | | 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.
* Update README.mdM Hickford2022-01-111-2/+1
| | | | Co-authored-by: Ran Benita <ran@unusedvar.com>
* Add instructions to run tests. Add build/ to .gitignore.matthickford2022-01-111-0/+2
|
* Add libxkbregistry to query available RMLVOPeter Hutterer2020-07-061-1/+1
| | | | | | | | | | | | | | | | | | | | | 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>
* README: update my email addressRan Benita2019-10-191-1/+1
| | | | Signed-off-by: Ran Benita <ran@unusedvar.com>
* README: usage questions are alrightRan Benita2019-02-261-1/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: stop pointing at bugs.freedesktop.orgRan Benita2019-02-261-5/+3
| | | | | | | 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>
* Convert http:// -> https:// where possibleRan Benita2017-12-211-3/+3
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README,PACKAGING: use the new meson unified command formatRan Benita2017-12-151-2/+2
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* build: add meson build systemRan Benita2017-07-311-7/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* README: Add basic build directionsBryce Harrington2016-09-161-0/+15
| | | | | | | | | | | | | | | | | | 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>
* README: Bug *reports* are welcomeBryce Harrington2016-09-161-1/+1
| | | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Yong Bakos <ybakos@humanoriented.com> Signed-off-by: Ran Benita <ran234@gmail.com>
* README: we also accepts patches through githubRan Benita2014-10-181-0/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: add notes about Compose supportRan Benita2014-10-181-2/+7
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: remove elaborate details from the introRan Benita2014-10-181-11/+2
| | | | | | Point to the "quick guide" instead. Signed-off-by: Ran Benita <ran234@gmail.com>
* README: move compatibility notes to their own pageRan Benita2014-10-181-42/+1
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: link to online API docsRan Benita2014-10-181-4/+4
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: move note about xkeyboard-config to its own sectionRan Benita2014-10-181-6/+8
| | | | Signed-off-by: Ran Benita <ran234@gmail.com>
* README: remove section on API stabilityRan Benita2014-10-181-8/+0
| | | | | | | 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>
* Reformat README markdownRan Benita2014-03-271-0/+109
So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
View Lorry Controller Status