aboutsummaryrefslogtreecommitdiff
path: root/nexgb
diff options
context:
space:
mode:
authorAndrew Gallant (Ocelot) <Andrew.Gallant@tufts.edu>2012-05-07 04:13:41 -0400
committerAndrew Gallant (Ocelot) <Andrew.Gallant@tufts.edu>2012-05-07 04:13:41 -0400
commiteed777ebfd37ceff35077c7a00555876e02b4b87 (patch)
tree9865c1656791799b97e493eef25a25b113e3a3f6 /nexgb
parentdc48249e1acea54b391f53b95f16e515dead7c97 (diff)
downloadhaven-eed777ebfd37ceff35077c7a00555876e02b4b87.tar.gz
haven-eed777ebfd37ceff35077c7a00555876e02b4b87.tar.xz
haven-eed777ebfd37ceff35077c7a00555876e02b4b87.zip
more info in readme. link to docs.
Diffstat (limited to 'nexgb')
-rw-r--r--nexgb/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/nexgb/README b/nexgb/README
index d2fd2dd..f5862b1 100644
--- a/nexgb/README
+++ b/nexgb/README
@@ -1,7 +1,19 @@
+XGB is the X Go Binding, which is a low-level API to communicate with the
+core X protocol and many of the X extensions. It is closely modeled after
+XCB and xpyb.
+
+It is thread safe and gets immediate improvement from parallelism when
+GOMAXPROCS > 1. (See the benchmarks in xgb_test.go for evidence.)
+
+Please see doc.go for more info.
+
BurntSushi's Fork
=================
I've forked the XGB repository from Google Code due to inactivty upstream.
+Godoc documentation can be found here:
+http://godoc.burntsushi.net/pkg/github.com/BurntSushi/xgb/
+
Much of the code has been rewritten in an effort to support thread safety
and multiple extensions. Namely, go_client.py has been thrown away in favor
of an xgbgen package.