Skip to content

Commit 0117fbc

Browse files
committed
docs: update build instructions for stable builds
Closes #23
1 parent b3f0d75 commit 0117fbc

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

readme.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ziglua
22
[![shield showing current tests status](https://github.com/natecraddock/ziglua/actions/workflows/tests.yml/badge.svg)](https://github.com/natecraddock/ziglua/actions/workflows/tests.yml)
33

4-
A Zig package that provides a complete and lightweight wrapper around the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4). Ziglua currently supports the latest releases of Lua 5.1, 5.2, 5.3, and 5.4 and targets Zig master.
4+
A Zig package that provides a complete and lightweight wrapper around the [Lua C API](https://www.lua.org/manual/5.4/manual.html#4). Ziglua currently supports the latest releases of Lua 5.1, 5.2, 5.3, and 5.4 and targets Zig master. Tagged versions of Ziglua are made for stable Zig releases.
55

66
Ziglua can be used in two ways, either
77
* **embedded** to statically embed the Lua VM in a Zig program,
@@ -44,14 +44,19 @@ First create a `build.zig.zon` file in your Zig project if you do not already ha
4444
.version = "0.0.1",
4545
.dependencies = .{
4646
.ziglua = .{
47+
// Use a tagged release of Ziglua tracking a stable Zig release
48+
.url = "https://github.com/natecraddock/ziglua/archive/refs/tags/0.2.0.tar.gz",
49+
50+
// Or a url with a hash for a specific Ziglua commit
4751
.url = "https://github.com/natecraddock/ziglua/archive/ab111adb06d2d4dc187ee9e1e352617ca8659155.tar.gz",
48-
.hash = "12206cf9e90462ee6e14f593ea6e0802b9fe434429ba10992a1451e32900f741005c",
4952
},
5053
}
5154
}
5255
```
5356

54-
Then in your `build.zig` file create and use the dependency
57+
When you run `zig build` it will instruct you to add a `.hash` field to this file.
58+
59+
In your `build.zig` file create and use the dependency
5560

5661
```zig
5762
pub fn build(b: *std.Build) void {

0 commit comments

Comments
 (0)