Skip to content

Commit dfcdbed

Browse files
Stebalienminad
authored andcommitted
Document xcb-proto regeneration
* README.md: Document where to get the xcb-proto definitions and how to re-generate the `.el` files.
1 parent 939ae90 commit dfcdbed

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,19 @@ It features an object-oriented API and permits a certain degree of concurrency.
66
It should enable you to implement some low-level X11 applications.
77
Please refer to [xelb.el](https://github.com/emacs-exwm/xelb/blob/master/xelb.el)
88
for more details.
9+
10+
## Regenerating XCB Bindings
11+
12+
Most (although not all) bindings in this library are auto-generated from [xcb-proto][]. To regenerate them:
13+
14+
1. Install your distro's `xcb-proto` package (`apt install xcb-proto`, `pacman -S xcb-proto`, etc.).
15+
2. Run `make`.
16+
17+
Alternatively:
18+
19+
1. Download the latest `xcb-proto` [release][xcb-proto-releases].
20+
2. Extract it.
21+
3. Run `make PROTO_PATH=/path/to/xcb-proto/src`
22+
23+
[xcb-proto]: https://gitlab.freedesktop.org/xorg/proto/xcbproto
24+
[xcb-proto-releases]: (https://gitlab.freedesktop.org/xorg/proto/xcbproto/-/tags)

0 commit comments

Comments
 (0)