Skip to content

Commit

Permalink
Make installation section of readme even more clear
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Hejsil authored Sep 16, 2024
1 parent de916df commit 7003678
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<REPLACE ME>` 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/<REPLACE ME>.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
```

Expand Down

0 comments on commit 7003678

Please sign in to comment.