summaryrefslogtreecommitdiff
path: root/README.md (unfollow)
Commit message (Collapse)AuthorFilesLines
2024-06-09Add installation instructions to READMEGravatar 12ball1-0/+15
2024-01-02Add autodoc websiteGravatar Abhinav Gupta1-0/+6
This adds a `zig build docs` step that builds the documentation website and writes it to zig-out/docs. It further includes a GitHub Workflow that publishes this website to GitHub Pages. The GitHub Workflow is divided into two jobs: - build: builds the documentation and uploads it - publish: downloads the documentation and publishes it These are separate jobs to minimize permissions available to the build job. This workflow runs on two events: - after every push to master - `workflow_dispatch`: this allows manually running the workflow from its *Actions* page if something went wrong --- **Important pre-merge steps:** If this PR is accepted, the following steps should be taken before merging the PR: 1. Go to **Settings** for the repository 2. Select **Pages** on the left under *Code and automation* 3. Under *Build and deployment* set **Source** to **GitHub Actions** 4. Merge the PR. If the steps are missed, the PR will merge just fine, but the docs job will fail immediately on merge. This can be remedied by following steps 1-3 above, and either adding a new commit on master, or manually firing the workflow from the Actions > API Reference page.
2023-12-13Remove the default allocator from `ParseOptions`Gravatar Jimmi Holst Christensen1-2/+20
fixes #111
2023-04-02Count occurrences of flags (was "Add .count type for flags") (#96)Gravatar Devin J. Pohly1-4/+5
Breaking change: parseEx now counts the number of occurrences of flag parameters (those with takes_value == .none) and returns the count as a u8. Users of the library will need to change if (arg_result.my_flag) to if (arg_result.my_flag != 0)
2023-01-12Fix misspelled thingsGravatar Jimmi Holst Christensen1-2/+2
2022-07-25Add clap.parsers.enumeration for parsing enumsGravatar Jimmi Holst Christensen1-0/+5
closes #78
2022-07-22Specify which version of Zig zig-clap targetsGravatar Komari Spaghetti1-0/+5
related #77
2022-03-30Update help and usage examplesGravatar Jimmi Holst Christensen1-6/+6
2022-03-30New `help` api that provides options as to how paramters are printed.Gravatar Jimmi Holst Christensen1-4/+8
fixes \#28
2022-03-23Fix usage output in READMEGravatar Jimmi Holst Christensen1-1/+1
2022-03-23Add parseParams and friendsGravatar Jimmi Holst Christensen1-25/+29
2022-03-09Allow for clap to parse argument values into typesGravatar Jimmi Holst Christensen1-61/+76
This changes - `.flag`, `.option`, `.options` and `.positionals` are now just fields you access on the result of `parse` and `parseEx`. - `clap.ComptimeClap` has been removed. - `clap.StreamingClap` is now called `clap.streaming.Clap` - `parse` and `parseEx` now takes a `value_parsers` argument that provides the parsers to parse values. - Remove `helpEx`, `helpFull`, `usageEx` and `usageFull`. They now just expect `Id` to have methods for getting the description and value texts.
2022-02-25Revert "Change clap into generating a struct"Gravatar Jimmi Holst Christensen1-24/+24
This reverts commit cfaac64c404fb1c2e892880410aa3b7dd881ea58.
2022-02-25Change clap into generating a structGravatar Jimmi Holst Christensen1-24/+24
This changes - `.flag`, `.option`, `.options` and `.positionals` are now just fields you access. - Move the current `clap.parse` and friends into `clap.untyped.parse` - This is in preperation for `clap.typed.parse`
2022-02-22Fix minor typos in README.mdGravatar Jimmi Holst Christensen1-1/+4
2022-01-31Refactor the ArgIterator interfaceGravatar Jimmi Holst Christensen1-4/+6
They now follow the interface provided by the standard library. This now means that we no longer needs `args.OsIterator` as that the one from `std` can now be used directly. Also remove `args.ShellIterator` as a simular iterator exists in `std` called `ArgIteratorGeneral`.
2021-12-21Master branch now follows zig masterGravatar Komari Spaghetti1-4/+0
It makes more sense to have the master branch follow zig master, and then create versioned branches to backport bug fixes to if nessesary
2021-11-29Improve help and usage examplesGravatar Jimmi Holst Christensen1-15/+23
Instead of just calling these function, have the examples be small programs that demonstrates how you would actually use them together with argument parsing. fixes #57
2021-10-09Fix uses of builtinGravatar Komari Spaghetti1-7/+7
2021-07-06Update example of `usage` (#45)Gravatar J.R. "hiljusti" Hill1-3/+3
2021-05-26Update to latest zig in preperation for 0.8.0Gravatar Komari Spaghetti1-8/+8
2021-05-08Modernize codebaseGravatar Komari Spaghetti1-22/+16
* Better naming for variables * Follow naming style of enums * Use `writer()` instead of `outStream()` * Change many initializers to be a one liner * Don't explicitly initialize fields to their default value
2021-04-28Refactor Diagnostic (and others) into a ParseOption structGravatar Komari Spaghetti1-14/+12
This allows for default arguments, which we can also extend without breaking peoples code in the future. This is a breaking change right now though.
2021-01-10zig master updatesGravatar Asherah Connor1-4/+4
2020-11-10Deprecate ComptimeClap in favor of parseExv0.3.0Gravatar Jimmi Holst Christensen1-54/+2
2020-11-10Better parseParamGravatar Jimmi Holst Christensen1-6/+2
2020-11-10Better parseParamGravatar Jimmi Holst Christensen1-6/+2
2020-11-02Report error context in Diagnostic (#26)Gravatar Komari Spaghetti1-6/+32
2020-11-02Report error context in Diagnostic (#26)Gravatar Komari Spaghetti1-6/+32
2020-09-06adjust examples, README templateGravatar Asherah Connor1-9/+17
2020-08-28adjust examples, README templateGravatar Asherah Connor1-15/+23
2020-08-15Fix expected type error on 32 bit systemsGravatar Jimmi Holst Christensen1-6/+6
fixes #23
2020-04-11rebuild readmeGravatar joachimschmidt5571-5/+4
2020-03-05Better readme for usageGravatar Jimmi Holst Christensen1-11/+2
2020-03-05Add clap.usageGravatar Jimmi Holst Christensen1-0/+43
2019-12-09update for latest zig (varargs is no more)Gravatar dbandstra1-9/+9
2019-12-01update for latest zigGravatar dbandstra1-6/+6
2019-11-27Add clap.parse as the simplest way of using the libGravatar Jimmi Holst Christensen1-64/+96
2019-11-09Breaking: OsIterator will now get the exe on initGravatar Jimmi Holst Christensen1-10/+4
2019-08-17correct comptime-clap-error.zig exampleGravatar Jimmi Holst Christensen1-7/+5
2019-08-17rebuild readmeGravatar Jimmi Holst Christensen1-0/+2
2019-08-17make help message look more like other toolsGravatar Jimmi Holst Christensen1-3/+3
2019-08-17adds parseParamGravatar Jimmi Holst Christensen1-25/+12
a less verbose way of getting a Param(Help).
2019-08-06build with latest version of zigGravatar Jimmi Holst Christensen1-17/+7
2019-06-21Embed examples in README during buildGravatar Jimmi HC1-74/+163
fixes #11
2019-01-21Removed duplicate in readmeGravatar Jimmi Holst Christensen1-4/+0
2019-01-17Updated readmeGravatar Jimmi Holst Christensen1-12/+10
2018-12-16Update README.mdv0.1.0Gravatar Jimmi Holst Christensen1-2/+2
2018-12-04Update README.mdGravatar Jimmi Holst Christensen1-5/+5
2018-11-16Update README.mdGravatar Jimmi Holst Christensen1-3/+3
HIC SVNT DRACONES