From 40446f6791a6840670a7aca9104039e856cc7d01 Mon Sep 17 00:00:00 2001 From: Travis Staloch <1562827+travisstaloch@users.noreply.github.com> Date: Sun, 29 Sep 2024 23:45:45 -0700 Subject: [PATCH] update readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00c4fb2..6b0df1f 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,11 @@ gen/People/Person.fb.zig ``` You can now import these files into your zig application. The compiled .fb.zig -files depend on a "flatbufferz" module which can be provided by: +files depend on a "flatbufferz" module which can be provided by running: +```console +zig fetch --save=flatbufferz https://github.com/travisstaloch/flatbufferz/archive/be8fc9bfdfe416fe5b2ce24ed8f0e16700c103fb.tar.gz +``` +That will add a dependency to your build.zig.zon: ```zig // build.zig.zon .{ @@ -56,7 +60,7 @@ files depend on a "flatbufferz" module which can be provided by: .dependencies = .{ .flatbufferz = .{ // note: you may need to change this url commit hash - .url = "https://github.com/travisstaloch/flatbufferz/archive/f8c035f29893a2b30902ed61b0d8702e8f52f435.tar.gz", + .url = "https://github.com/travisstaloch/flatbufferz/archive/be8fc9bfdfe416fe5b2ce24ed8f0e16700c103fb.tar.gz", }, } } @@ -73,6 +77,10 @@ const flatbufferz_mod = flatbufferz_dep.module("flatbufferz"); my_exe.addModule("flatbufferz", flatbufferz_mod); ``` +# Gen Step +To generate code in your build.zig see the example in (#18)[https://github.com/travisstaloch/flatbufferz/pull/18]. + + # Tools Convert .bfbs to .fbs. ```console