update README and rename (wayland->wl in project name)
This commit is contained in:
@@ -1,20 +1,15 @@
|
||||
# Wayland Protocol Code Generator
|
||||
|
||||
Code generation for Wayland protocols, for use without libwayland.
|
||||
Generated code is NOT ABI compatible with libwayland.
|
||||
|
||||
I wrote this to use in my own projects to avoid the callback-heavy
|
||||
interface provided by libwayland and the standard wayland-scanner.
|
||||
Generated code is NOT ABI compatible with libwayland. Users of the generated
|
||||
code are expected to implement Wayland wire communication handling themselves.
|
||||
|
||||
This generator currently only supports generating Zig code, but I plan
|
||||
to add an option to emit the code as a single-header C library too.
|
||||
|
||||
I'll probably also give this all a cleanup pass soon. This code was all
|
||||
written rather quickly and probably can be tidied up.
|
||||
to add an option to emit the code as a single-header C library in the future.
|
||||
|
||||
> [!NOTE]
|
||||
> This program currently only generates client-compatible code.
|
||||
> Support for server-compatible codegen may come later if I feel like it.
|
||||
> Support for server-compatible codegen may come later.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -25,7 +20,7 @@ and `protocols.zig` can be generated by running the program as below:
|
||||
|
||||
```
|
||||
# The program can be run with as many input protocols as you'd like
|
||||
$ ./zig-out/bin/wayland-protocol-generator -o protocols.zig path/to/wayland.xml path/to/protocol1.xml path/to/protocolN.xml
|
||||
$ ./zig-out/bin/wl-protocol-codegen -o protocols.zig path/to/wayland.xml path/to/protocol1.xml path/to/protocolN.xml
|
||||
```
|
||||
|
||||
This will read in all provided xml files and produce a single `protocols.zig`
|
||||
@@ -45,7 +40,7 @@ as a module as follows:
|
||||
Add this repo as a dependency. You can do this manually or by invoking:
|
||||
|
||||
```shell
|
||||
$ zig fetch --save git+https://github.com/ptrToLiam/wayland-protocol-codegen
|
||||
$ zig fetch --save git+https://github.com/ptrToLiam/wl-protocol-codegen
|
||||
```
|
||||
|
||||
Then add some lines such as the following to your `build.zig`:
|
||||
@@ -58,7 +53,7 @@ const wayland_protocol_specifications = [_]std.Build.LazyPath{
|
||||
...,
|
||||
};
|
||||
|
||||
const wayland_protocols = b.dependency("wayland_protocol_codegen", .{
|
||||
const wayland_protocols = b.dependency("wl_protocol_codegen", .{
|
||||
.protocols = &wayland_protocol_specifications,
|
||||
}).module("wayland-protocols");
|
||||
exe.root_module.addImport("wayland-protocols", wayland_protocols);
|
||||
@@ -66,4 +61,3 @@ exe.root_module.addImport("wayland-protocols", wayland_protocols);
|
||||
|
||||
This will allow you to import the protocol code with
|
||||
`@import("wayland-protocols")` in your executable module's source code.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user