diff options
| author |  Jimmi Holst Christensen | 2024-09-21 14:10:17 +0200 |
|---|---|---|
| committer | Jimmi Holst Christensen | 2024-09-21 14:10:17 +0200 |
| commit | e9207ad2b86131fa9f0dfbd5c68cafd67f00fe64 (patch) | |
| tree | 47eea18b21780a15d6c67a2bf845e3e15fff3292 /example | |
| parent | Make installation section of readme even more clear (diff) | |
| download | zig-clap-e9207ad2b86131fa9f0dfbd5c68cafd67f00fe64.tar.gz zig-clap-e9207ad2b86131fa9f0dfbd5c68cafd67f00fe64.tar.xz zig-clap-e9207ad2b86131fa9f0dfbd5c68cafd67f00fe64.zip | |
Move updated README to template
Diffstat (limited to 'example')
| -rw-r--r-- | example/README.md.template | 19 |
1 files 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. | |||
| 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 | ||