summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Komari Spaghetti2024-09-16 16:55:09 +0200
committerGravatar GitHub2024-09-16 16:55:09 +0200
commit7003678307b72bc25869308d7435a79114d1ac42 (patch)
treebe40306a8795baf6c0194421d78248625e4a9f4f /README.md
parentfix: Cicd use `with: master` as `latest` is the default (diff)
downloadzig-clap-7003678307b72bc25869308d7435a79114d1ac42.tar.gz
zig-clap-7003678307b72bc25869308d7435a79114d1ac42.tar.xz
zig-clap-7003678307b72bc25869308d7435a79114d1ac42.zip
Make installation section of readme even more clear
The installation section no longer assumes that all developers use the master branch of Zig. Instead if provides different steps depending on which Zig version developers are using. Related #61
Diffstat (limited to '')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index d15063a..bc38b58 100644
--- a/README.md
+++ b/README.md
@@ -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