Subject: [PATCH] Docs: README: Clean up grammar/formatting, and mention buzilla Date: Thu, 21 Jun 2012 16:49:29 +0000 From: Michael Witten The main change provided by this commit is information on where to submit and bug reports and patches, namely freedesktop's bugzilla system. Otherwise, the content remains much the same; there are only structural changes (grammar, white space improvements, etc.) --- README | 60 +++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 41 insertions(+), 19 deletions(-) diff --git a/README b/README index d91eda6..3c98aac 100644 --- a/README +++ b/README @@ -1,28 +1,50 @@ X Keyboard Extension -------------------- -The X Keyboard Extension essentially replaces the core protocol definition of -keyboard. The extension makes possible to clearly and explicitly specify most -aspects of keyboard behaviour on per-key basis and to more closely track the -logical and physical state of the keyboard. It also includes a number of -keyboard controls designed to make keyboards more accessible to people with -physical impairments. +The X Keyboard (XKB) Extension essentially replaces the core protocol +definition of a keyboard. The extension makes it possible to specify +clearly and explicitly most aspects of keyboard behaviour on a per-key +basis, and to track more closely the logical and physical state of a +keyboard. It also includes a number of keyboard controls designed to +make keyboards more accessible to people with physical impairments. -There are five types of components in the server database corresponing to five -xkb symbolic names: symbols, geometry, keycodes, compat and types which -determine the keyboard behaviour. These five components can combined together -into a resulting keyboard mapping using the 'rules' component. +There are five components that define a complete keyboard mapping: +symbols, geometry, keycodes, compat, and types; these five components +can be combined together using the 'rules' component of the database +provided by this project, XKeyboardConfig. -The complete specification can be found on -http://xfree86.org/current/XKBproto.pdf +The complete specification for the XKB Extension can be found here: -For XKB configuration information see 'docs/README.config' file. + http://xfree86.org/current/XKBproto.pdf -For information how to further enhance XKB configuration see 'docs/README.enhancing' -file. +XKeyboardConfig +--------------- -For information how to replace existing XKB configuration database with -XKeyboardConfig see 'docs/HOWTO.transition' file. +This project provides a consistent, well-structured, frequently +released, open source database of keyboard configuration data. The +project is targeted to XKB-based systems. -Contribution guidelines are described at -http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules +For XKB configuration information, see: + + docs/README.config + +For information on how to enhance the database itself, see: + + docs/README.enhancing + +For information on how to replace an older XKB configuration database +with the one provided by this project, see: + + docs/HOWTO.transition + +For guidelines to making contributions to this project, see: + + http://www.freedesktop.org/wiki/Software/XKeyboardConfig/Rules + +To submit bug reports (and patches), please use the bugzilla system: + + https://bugs.freedesktop.org/ + +specifically: + + https://bugs.freedesktop.org/enter_bug.cgi?product=xkeyboard-config -- 1.7.10.2.485.g86c2178