From 7003678307b72bc25869308d7435a79114d1ac42 Mon Sep 17 00:00:00 2001 From: Komari Spaghetti Date: Mon, 16 Sep 2024 16:55:09 +0200 Subject: 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--- README.md | 19 ++++++++++++------- 1 file 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. A simple and easy to use command line argument parser library for Zig. -The master branch of zig-clap targets the master branch of Zig. For a -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: +Developers tend to either use +* The latest tagged release of Zig +* The latest build of Zigs master branch -``` +Depending on which developer you are, you need to run different `zig fetch` commands: + +```sh +# Version of zig-clap that works with a tagged release of Zig +# Replace `` with the version of zig-clap that you want to use +# See: https://github.com/Hejsil/zig-clap/releases +zig fetch --save https://github.com/Hejsil/zig-clap/archive/refs/tags/.tar.gz + +# Version of zig-clap that works with latest build of Zigs master branch zig fetch --save git+https://github.com/Hejsil/zig-clap ``` -- cgit v1.2.3