diff options
| author | Přemysl Janouch <p@janouch.name> | 2018-09-08 19:39:28 +0200 |
|---|---|---|
| committer | Přemysl Janouch <p@janouch.name> | 2018-09-08 19:51:53 +0200 |
| commit | 48fb710f357a363cce043a9f546e8a4aff196786 (patch) | |
| tree | f6d4102339db3776887def299285b29c103bdd94 /nexgb/README | |
| parent | 3173202cc1e08762c6e156a8fffd23269a5ddb2b (diff) | |
| download | haven-48fb710f357a363cce043a9f546e8a4aff196786.tar.gz haven-48fb710f357a363cce043a9f546e8a4aff196786.tar.xz haven-48fb710f357a363cce043a9f546e8a4aff196786.zip | |
nexgb: post-merge fixups and cleanups
AUTHORS, CONTRIBUTORS: still useful, add people from git log, clean up.
LICENSE: Google doesn't really grant you shit anymore. The EU doesn't
have software patents either, so it doesn't affect me directly.
README, doc.go: erase mentions of unmaintained xgbutil.
Diffstat (limited to 'nexgb/README')
| -rw-r--r-- | nexgb/README | 46 |
1 files changed, 19 insertions, 27 deletions
diff --git a/nexgb/README b/nexgb/README index c96a5fb..090f178 100644 --- a/nexgb/README +++ b/nexgb/README @@ -1,26 +1,28 @@ -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. +neXGB is a fork of a fork of 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 modelled after XCB and xpyb. It is thread safe and gets immediate improvement from parallelism when GOMAXPROCS > 1. (See the benchmarks in xproto/xproto_test.go for evidence.) Please see doc.go for more info. -Note that unless you know you need XGB, you can probably make your life -easier by using a slightly higher level library: xgbutil. +Quick usage +----------- + go get janouch.name/haven/nexgb + go run $GOPATH/src/janouch.name/haven/nexgb/examples/create-window/main.go -Quick Usage -=========== -go get github.com/BurntSushi/xgb -go run go/path/src/github.com/BurntSushi/xgb/examples/create-window/main.go +Přemysl Janouch's fork +---------------------- +I've merged BurntSushi/xgb into haven as a subdirectory due to a/ inactivity +upstream, and b/ intentions to make incompatible changes meant to be in sync +with the rest of the project. -BurntSushi's Fork -================= -I've forked the XGB repository from Google Code due to inactivty upstream. +It's Not Exactly XGB anymore. -Godoc documentation can be found here: -http://godoc.burntsushi.net/pkg/github.com/BurntSushi/xgb/ +BurntSushi's fork +----------------- +I've forked the XGB repository from Google Code due to inactivity upstream. 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 @@ -37,18 +39,8 @@ in tact. I suppose I can legitimately release xgbgen under the WTFPL. To be fair, it is at least as complex as XGB itself. *sigh* -What follows is the original README: - -XGB README -========== -XGB is the X protocol Go language Binding. - -It is the Go equivalent of XCB, the X protocol C-language Binding -(http://xcb.freedesktop.org/). - -Unless otherwise noted, the XGB source files are distributed +License +------- +Unless otherwise noted, the neXGB source files are distributed under the BSD-style license found in the LICENSE file. -Contributions should follow the same procedure as for the Go project: -http://golang.org/doc/contribute.html - |