Skip to content

Commit 988cc9a

Browse files
author
Stephen Gutekanst
authored
README: clarify project
1 parent 9ccb0de commit 988cc9a

File tree

1 file changed

+1
-52
lines changed

1 file changed

+1
-52
lines changed

README.md

+1-52
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,3 @@
11
# vulkan-zig-generated
22

3-
[Snektron/vulkan-zig](https://github.com/Snektron/vulkan-zig), generated for you, so that you can depend on it via the Zig package manager.
4-
5-
## Experimental
6-
7-
This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/about/stability/):
8-
9-
> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code.
10-
11-
**Status**: Used in Mach so relatively stable, but you can consider using [Snektron/vulkan-zig](https://github.com/Snektron/vulkan-zig) directly depending on your use case.
12-
13-
## Getting started
14-
15-
### Adding dependency
16-
17-
Create a `build.zig.zon` file in your project (replace `$LATEST_COMMIT` with the latest commit hash):
18-
19-
```
20-
.{
21-
.name = "mypkg",
22-
.version = "0.1.0",
23-
.dependencies = .{
24-
.vulkan_zig_generated = .{
25-
.url = "https://pkg.machengine.org/vulkan-zig-generated/$LATEST_COMMIT.tar.gz",
26-
},
27-
},
28-
}
29-
```
30-
31-
Run `zig build` in your project, and the compiler instruct you to add a `.hash = "..."` field next to `.url`.
32-
33-
Then use the dependency in your `build.zig`:
34-
35-
```zig
36-
...
37-
pub fn build(b: *Build) void {
38-
...
39-
exe.addModule("vulkan-zig-generated", b.dependency("vulkan_zig_generated", .{
40-
.target = target,
41-
.optimize = optimize,
42-
}).module("vulkan_zig_generated"));
43-
}
44-
```
45-
46-
You may then `const vk = @import("vulkan-zig-generated");` and use it.
47-
48-
### Usage
49-
50-
For usage, see [Snektron/vulkan-zig](https://github.com/Snektron/vulkan-zig).
51-
52-
## Issues
53-
54-
Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Avulkan-zig-generated).
3+
[Snektron/vulkan-zig](https://github.com/Snektron/vulkan-zig), but pre-generated. You should consider using vulkan-zig directly and only use this if you understand the tradeoffs.

0 commit comments

Comments
 (0)