summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2d71678
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+About XCB util modules
+======================
+
+The XCB util modules provides a number of libraries which sit on top
+of libxcb, the core X protocol library, and some of the extension
+libraries. These experimental libraries provide convenience functions
+and interfaces which make the raw X protocol more usable. Some of the
+libraries also provide client-side code which is not strictly part of
+the X protocol but which have traditionally been provided by Xlib.
+
+If you find any of these libraries useful, please let us know what
+you're using and why you aren't in a mental hospital yet. We'd welcome
+patches/suggestions for enhancement and new libraries; Please report any
+issues you find to the freedesktop.org bug tracker, at:
+
+ https://gitlab.freedesktop.org/xorg/lib/libxcb-keysyms/issues
+
+Discussion about XCB occurs on the XCB mailing list:
+
+ http://lists.freedesktop.org/mailman/listinfo/xcb
+
+About XCB util-keysyms module
+=============================
+
+XCB util-keysyms module provides the following library:
+
+ - keysyms: Standard X key constants and conversion to/from keycodes.
+
+You can obtain the latest development versions of XCB util-keysyms
+using GIT from <https://gitlab.freedesktop.org/xorg/lib/libxcb-keysyms>.
+
+ For anonymous checkouts, use:
+
+ git clone --recursive https://gitlab.freedesktop.org/xorg/lib/libxcb-keysyms.git
+
+ For developers, use:
+
+ git clone --recursive git@gitlab.freedesktop.org:xorg/lib/libxcb-keysyms.git