github.com/BurntSushi/xgb@v0.0.0-20210121224620-deaf085860bc/README (about)

     1  Note that this project is largely unmaintained as I don't have the time to do
     2  or support more development. Please consider using this fork instead:
     3  https://github.com/jezek/xgb
     4  
     5  
     6  XGB is the X Go Binding, which is a low-level API to communicate with the
     7  core X protocol and many of the X extensions. It is closely modeled after
     8  XCB and xpyb.
     9  
    10  It is thread safe and gets immediate improvement from parallelism when
    11  GOMAXPROCS > 1. (See the benchmarks in xproto/xproto_test.go for evidence.)
    12  
    13  Please see doc.go for more info.
    14  
    15  Note that unless you know you need XGB, you can probably make your life
    16  easier by using a slightly higher level library: xgbutil.
    17  
    18  Quick Usage
    19  ===========
    20  go get github.com/BurntSushi/xgb
    21  go run go/path/src/github.com/BurntSushi/xgb/examples/create-window/main.go
    22  
    23  BurntSushi's Fork
    24  =================
    25  I've forked the XGB repository from Google Code due to inactivty upstream.
    26  
    27  Godoc documentation can be found here:
    28  https://godoc.org/github.com/BurntSushi/xgb
    29  
    30  Much of the code has been rewritten in an effort to support thread safety
    31  and multiple extensions. Namely, go_client.py has been thrown away in favor
    32  of an xgbgen package.
    33  
    34  The biggest parts that *haven't* been rewritten by me are the connection and
    35  authentication handshakes. They're inherently messy, and there's really no
    36  reason to re-work them. The rest of XGB has been completely rewritten.
    37  
    38  I like to release my code under the WTFPL, but since I'm starting with someone
    39  else's work, I'm leaving the original license/contributor/author information
    40  in tact.
    41  
    42  I suppose I can legitimately release xgbgen under the WTFPL. To be fair, it is
    43  at least as complex as XGB itself. *sigh*
    44  
    45  What follows is the original README:
    46  
    47  XGB README
    48  ==========
    49  XGB is the X protocol Go language Binding.
    50  
    51  It is the Go equivalent of XCB, the X protocol C-language Binding
    52  (http://xcb.freedesktop.org/).
    53  
    54  Unless otherwise noted, the XGB source files are distributed
    55  under the BSD-style license found in the LICENSE file.
    56  
    57  Contributions should follow the same procedure as for the Go project:
    58  http://golang.org/doc/contribute.html
    59