Add installation instructions to README

Hejsil · Jun 9, 2024 · 7a51c11 · 7a51c11
1 parent 60cd46a
commit 7a51c11
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,21 @@ version of zig-clap that targets a specific Zig release, have a look
 at the releases. Each release specifies the Zig version it compiles with
 in the release notes.
 
+## Installation
+
+First, run the following:
+
+```
+zig fetch --save git+https://github.com/Hejsil/zig-clap
+```
+
+Then add the following to `build.zig`:
+
+```zig
+const clap = b.dependency("clap", .{});
+exe.root_module.addImport("clap", clap.module("clap"));
+```
+
 ## Features
 
 * Short arguments `-a`

diff --git a/example/README.md.template b/example/README.md.template
@@ -10,6 +10,21 @@ version of zig-clap that targets a specific Zig release, have a look
 at the releases. Each release specifies the Zig version it compiles with
 in the release notes.
 
+## Installation
+
+First, run the following:
+
+```
+zig fetch --save git+https://github.com/Hejsil/zig-clap
+```
+
+Then add the following to `build.zig`:
+
+```zig
+const clap = b.dependency("clap", .{{}});
+exe.root_module.addImport("clap", clap.module("clap"));
+```
+
 ## Features
 
 * Short arguments `-a`