From 2bd3e97f988d69b58fe5d21d926ffc2ee66c8faf Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 20 Jan 2026 23:10:25 -0800 Subject: docs(README.md): Provide proper README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) 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#` 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). -- cgit v1.2.3