diff options
| author | 2024-09-16 16:55:09 +0200 | |
|---|---|---|
| committer | 2024-09-16 16:55:09 +0200 | |
| commit | 7003678307b72bc25869308d7435a79114d1ac42 (patch) | |
| tree | be40306a8795baf6c0194421d78248625e4a9f4f /README.md | |
| parent | fix: Cicd use `with: master` as `latest` is the default (diff) | |
| download | zig-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 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 12 insertions, 7 deletions
| @@ -5,16 +5,21 @@ README.md is autogenerated. Please edit example/README.md.template instead. | |||
| 5 | 5 | ||
| 6 | A simple and easy to use command line argument parser library for Zig. | 6 | A simple and easy to use command line argument parser library for Zig. |
| 7 | 7 | ||
| 8 | The master branch of zig-clap targets the master branch of Zig. For a | ||
| 9 | version of zig-clap that targets a specific Zig release, have a look | ||
| 10 | at the releases. Each release specifies the Zig version it compiles with | ||
| 11 | in the release notes. | ||
| 12 | |||
| 13 | ## Installation | 8 | ## Installation |
| 14 | 9 | ||
| 15 | First, run the following: | 10 | Developers tend to either use |
| 11 | * The latest tagged release of Zig | ||
| 12 | * The latest build of Zigs master branch | ||
| 16 | 13 | ||
| 17 | ``` | 14 | Depending 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 | ||
| 20 | zig 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 | ||
| 18 | zig fetch --save git+https://github.com/Hejsil/zig-clap | 23 | zig fetch --save git+https://github.com/Hejsil/zig-clap |
| 19 | ``` | 24 | ``` |
| 20 | 25 | ||