summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 2 insertions, 20 deletions
diff --git a/README.md b/README.md
index 1ecf9e4..39273c3 100644
--- a/README.md
+++ b/README.md
@@ -83,24 +83,10 @@ There are three main ways to include `zig-sqlite` in your project:
83 83
84## Official package manager 84## Official package manager
85 85
86Add this as one of the `.dependencies` inside your `build.zig.zon` file: 86Use the following `zig fetch` command:
87```zig
88.sqlite = .{
89 .url = "https://github.com/vrischmann/zig-sqlite/archive/COMMIT.tar.gz",
90 .hash = <hash value>,
91},
92```
93
94This tells zig to fetch zig-sqlite from a tarball provided by GitHub. Make sure to replace the `COMMIT` part with an actual commit SHA in long form, like `219faa2a5cd5a268a865a1100e92805df4b84610`.
95Every time you want to update zig-sqlite you'll have to update this commit.
96 87
97You'll have to provide the `hash` field too which is actually a litte annoying because the hash is of the _content_, not the _archive_ (see [the Zig 0.11 release notes](https://ziglang.org/download/0.11.0/release-notes.html#Package-Management)).
98The easiest way to get the hash value is to omit it from the file and run `zig build`, it will report an error like this:
99``` 88```
100Fetch Packages... sqlite... /Users/vincent/dev/perso/projects/zig-sqlite-demo/build.zig.zon:6:11: error: url field is missing corresponding hash field 89zig fetch --save git+https://github.com/vrischmann/zig-sqlite
101 .url = "https://github.com/vrischmann/zig-sqlite/archive/219faa2a5cd5a268a865a1100e92805df4b84610.tar.gz",
102 ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103note: expected .hash = "122088f0b73f5adcf07c9af8437c5149ed35c3f16f6393c330a294bdd5f91f069a08",
104``` 90```
105 91
106Now in your `build.zig` you can access the module like this: 92Now in your `build.zig` you can access the module like this:
@@ -109,11 +95,7 @@ const sqlite = b.dependency("sqlite", .{
109 .target = target, 95 .target = target,
110 .optimize = optimize, 96 .optimize = optimize,
111}); 97});
112
113exe.root_module.addImport("sqlite", sqlite.module("sqlite")); 98exe.root_module.addImport("sqlite", sqlite.module("sqlite"));
114
115// links the bundled sqlite3, so leave this out if you link the system one
116exe.linkLibrary(sqlite.artifact("sqlite"));
117``` 99```
118 100
119## zigmod 101## zigmod