aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2026-01-20 23:10:25 -0800
committerFuwn <[email protected]>2026-01-20 23:10:25 -0800
commit2bd3e97f988d69b58fe5d21d926ffc2ee66c8faf (patch)
tree0b5206628ed3fd85447a9490ea784ebe5391600f
parentchore: Relicense project under the ISC license (diff)
downloadzigr-2bd3e97f988d69b58fe5d21d926ffc2ee66c8faf.tar.xz
zigr-2bd3e97f988d69b58fe5d21d926ffc2ee66c8faf.zip
docs(README.md): Provide proper READMEHEADmain
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 71e89ec..320b1ca 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,16 @@
+# 🦎 ZIGR
+
+> Zig bindings for [TIGR](https://github.com/erkkah/tigr/) (TIny GRaphics library)
+
# Updating Instructions
-1. Find the latest tigr release
+1. Find the latest [TIGR](https://github.com/erkkah/tigr/) release
2. Run `zig fetch --save=tigr "git+github.com/erkkah/tigr#<COMMIT_HASH>`
3. Run `zig build bindgen`
4. Run `git apply --check bindings.patch`
5. If that works, run `git apply bindings.patch`
6. Add new functions to `src/main.zig`
7. Update `version` and `minimum_zig_version` in `build.zig.zon`
+
+## Licence
+
+This project is licensed under the [ISC license](./LICENSE).