summaryrefslogtreecommitdiff
path: root/example/README.md.template
diff options
context:
space:
mode:
Diffstat (limited to 'example/README.md.template')
-rw-r--r--example/README.md.template19
1 files changed, 12 insertions, 7 deletions
diff --git a/example/README.md.template b/example/README.md.template
index 87832ee..dda0cc9 100644
--- a/example/README.md.template
+++ b/example/README.md.template
@@ -5,16 +5,21 @@ README.md is autogenerated. Please edit example/README.md.template instead.
5 5
6A simple and easy to use command line argument parser library for Zig. 6A simple and easy to use command line argument parser library for Zig.
7 7
8The master branch of zig-clap targets the master branch of Zig. For a
9version of zig-clap that targets a specific Zig release, have a look
10at the releases. Each release specifies the Zig version it compiles with
11in the release notes.
12
13## Installation 8## Installation
14 9
15First, run the following: 10Developers tend to either use
11* The latest tagged release of Zig
12* The latest build of Zigs master branch
16 13
17``` 14Depending on which developer you are, you need to run different `zig fetch` commands:
15
16```sh
17# Version of zig-clap that works with a tagged release of Zig
18# Replace `<REPLACE ME>` with the version of zig-clap that you want to use
19# See: https://github.com/Hejsil/zig-clap/releases
20zig fetch --save https://github.com/Hejsil/zig-clap/archive/refs/tags/<REPLACE ME>.tar.gz
21
22# Version of zig-clap that works with latest build of Zigs master branch
18zig fetch --save git+https://github.com/Hejsil/zig-clap 23zig fetch --save git+https://github.com/Hejsil/zig-clap
19``` 24```
20 25