From 1838faf3f96e99eb76a15ba375f1ac4843f7b3cd Mon Sep 17 00:00:00 2001
From: BratishkaErik <25210740+BratishkaErik@users.noreply.github.com>
Date: Sat, 19 Mar 2022 20:43:23 +0600
Subject: [PATCH] glfw: add instructions for Gyro in README.md (#184)

* glfw: add instructions for Gyro in README.md
---
 glfw/README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/glfw/README.md b/glfw/README.md
index 4f687d43..39347a6f 100644
--- a/glfw/README.md
+++ b/glfw/README.md
@@ -43,15 +43,18 @@ A minimal Vulkan example can be found in the [mach-glfw-vulkan-example](https://
 
 ## Getting started
 
+### Adding dependency (using Git)
+
 In a `libs` subdirectory of the root of your project:
 
-```sg
+```sh
 git clone https://github.com/hexops/mach-glfw
 ```
 
 Then in your `build.zig` add:
 
 ```zig
+...
 const glfw = @import("libs/mach-glfw/build.zig");
 
 pub fn build(b: *Builder) void {
@@ -61,6 +64,33 @@ pub fn build(b: *Builder) void {
 }
 ```
 
+### Adding dependency (using Gyro)
+
+```sh
+gyro add --src github hexops/mach-glfw --root src/main.zig --alias glfw
+gyro add --build-dep --src github hexops/mach-glfw --root build.zig --alias build-glfw
+```
+
+Then in your `build.zig` add:
+
+```zig
+...
+const pkgs = @import("deps.zig").pkgs;
+const glfw = @import("build-glfw");
+
+pub fn build(b: *Builder) void {
+    ...
+
+    exe.addPackage(pkgs.glfw);
+    glfw.link(b, exe, .{});
+}
+```
+
+**WARNING: You should use `gyro build` instead of `zig build` now!**
+
+
+# Next steps
+
 Now in your code you may import and use GLFW:
 
 ```zig