summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2022-10-18 18:19:57 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2022-10-18 18:23:00 -0700
commitf85a73865aabed74c311b90b44c0f7c643e05e2a (patch)
tree62c6bf025a3fac7810560d6fdad36ed0a4ee8964
parent517dd82c079de762a7426f20166a44f11e8d38c5 (diff)
Add README.mdHEADmaster
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r--Makefile.am2
-rw-r--r--README.md23
2 files changed, 24 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index bdf4a30..3664c76 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -12,7 +12,7 @@ ChangeLog:
dist-hook: ChangeLog INSTALL
-EXTRA_DIST = autogen.sh xcb-errors.pc.in src/errors.h src/extensions.py
+EXTRA_DIST = autogen.sh xcb-errors.pc.in src/errors.h src/extensions.py README.md
lib_LTLIBRARIES = libxcb-errors.la
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29bc6e2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+xcb-util-errors is a utility library that gives human readable names to error
+codes and event codes and also to major and minor numbers.
+
+The necessary information is drawn from xcb-proto's protocol descriptions.
+
+This library is especially useful when working with extensions and is mostly
+useful for debugging.
+
+All questions regarding this software should be directed at the
+XCB mailing list:
+
+ https://lists.x.org/mailman/listinfo/xcb
+
+The primary development code repository can be found at:
+
+ https://gitlab.freedesktop.org/xorg/lib/libxcb-errors
+
+Please submit bug reports and requests to merge patches there.
+
+For patch submission instructions, see:
+
+ https://www.x.org/wiki/Development/Documentation/SubmittingPatches
+