add: MIT-LICENSE with README updates
Some checks failed
Zig Project Action / Lint, Spell-check and test zig project (push) Failing after 32s

This commit is contained in:
2024-11-13 19:01:53 +01:00
parent bc1bc757d4
commit 9bf146257a
2 changed files with 23 additions and 1 deletions

View File

@@ -7,8 +7,21 @@
## Usage
To include `zterm` as a dependency in your project run the following command:
To add or update `zterm` as a dependency in your project run the following command:
```sh
zig fetch --save git+https://gitea.yves-biener.de/yves-biener/zterm
```
Add the dependency to your module as follows in your _build.zig_:
```zig
const zterm: *Dependency = b.dependency("zterm", .{
.target = target,
.optimize = optimize,
});
// ...
exe.root_module.addImport("zterm", zterm.module("zterm"));
```
For an example you can take a look at [build.zig](build.zig) for an example.