From e9207ad2b86131fa9f0dfbd5c68cafd67f00fe64 Mon Sep 17 00:00:00 2001 From: Jimmi Holst Christensen Date: Sat, 21 Sep 2024 14:10:17 +0200 Subject: Move updated README to template --- example/README.md.template | 19 ++++++++++++------- 1 file 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. 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