summaryrefslogtreecommitdiff
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: Don't autogenerate the READMEGravatar Jimmi Holst Christensen2025-03-271-3/+0
|
* Update README.mdGravatar Komari Spaghetti2025-02-241-3/+3
|
* Patch up README and fix comments in example files. (#143)Gravatar JustAnotherCodemonkey2024-11-251-28/+26
| | | The readme was also reflowed to 100 cols. I probably should have put that in a separate commit but oh well. The comments were not subjected to reflowing (yet).
* fix: Subcommand example comments needs a scroll to be readGravatar Jimmi Holst Christensen2024-10-241-6/+6
|
* docs: Add subcommand exampleGravatar Jimmi Holst Christensen2024-10-241-1/+106
|
* feat: Support multiple positionals of different typesGravatar Jimmi Holst Christensen2024-10-241-5/+5
|
* refactor: Always access using full namespaceGravatar Jimmi Holst Christensen2024-10-221-44/+33
| | | | This is my new preferred style of programming Zig :)
* Make installation section of readme even more clearGravatar Komari Spaghetti2024-09-161-7/+12
| | | | | | | 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
* feat: Allow for the assignment separator to be configuredGravatar Jimmi Holst Christensen2024-07-181-0/+3
|
* Add installation instructions to READMEGravatar 12ball2024-06-091-0/+15
|
* Add autodoc websiteGravatar Abhinav Gupta2024-01-021-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.
* Remove the default allocator from `ParseOptions`Gravatar Jimmi Holst Christensen2023-12-131-2/+20
| | | | fixes #111
* Count occurrences of flags (was "Add .count type for flags") (#96)Gravatar Devin J. Pohly2023-04-021-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)
* Fix misspelled thingsGravatar Jimmi Holst Christensen2023-01-121-2/+2
|
* Add clap.parsers.enumeration for parsing enumsGravatar Jimmi Holst Christensen2022-07-251-0/+5
| | | | closes #78
* Specify which version of Zig zig-clap targetsGravatar Komari Spaghetti2022-07-221-0/+5
| | | related #77
* Update help and usage examplesGravatar Jimmi Holst Christensen2022-03-301-6/+6
|
* New `help` api that provides options as to how paramters are printed.Gravatar Jimmi Holst Christensen2022-03-301-4/+8
| | | | fixes \#28
* Fix usage output in READMEGravatar Jimmi Holst Christensen2022-03-231-1/+1
|
* Add parseParams and friendsGravatar Jimmi Holst Christensen2022-03-231-25/+29
|
* Allow for clap to parse argument values into typesGravatar Jimmi Holst Christensen2022-03-091-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.
* Revert "Change clap into generating a struct"Gravatar Jimmi Holst Christensen2022-02-251-24/+24
| | | | This reverts commit cfaac64c404fb1c2e892880410aa3b7dd881ea58.
* Change clap into generating a structGravatar Jimmi Holst Christensen2022-02-251-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`
* Fix minor typos in README.mdGravatar Jimmi Holst Christensen2022-02-221-1/+4
|
* Refactor the ArgIterator interfaceGravatar Jimmi Holst Christensen2022-01-311-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`.
* Master branch now follows zig masterGravatar Komari Spaghetti2021-12-211-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
* Improve help and usage examplesGravatar Jimmi Holst Christensen2021-11-291-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
* Fix uses of builtinGravatar Komari Spaghetti2021-10-091-7/+7
|
* Update example of `usage` (#45)Gravatar J.R. "hiljusti" Hill2021-07-061-3/+3
|
* Update to latest zig in preperation for 0.8.0Gravatar Komari Spaghetti2021-05-261-8/+8
|
* Modernize codebaseGravatar Komari Spaghetti2021-05-081-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
* Refactor Diagnostic (and others) into a ParseOption structGravatar Komari Spaghetti2021-04-281-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.
* Deprecate ComptimeClap in favor of parseExv0.3.0Gravatar Jimmi Holst Christensen2020-11-101-54/+2
|
* Better parseParamGravatar Jimmi Holst Christensen2020-11-101-6/+2
|
* Report error context in Diagnostic (#26)Gravatar Komari Spaghetti2020-11-021-6/+32
|
* adjust examples, README templateGravatar Asherah Connor2020-08-281-15/+23
|
* Merge branch 'master' into zig-masterGravatar Jimmi Holst Christensen2020-04-181-0/+36
|\
| * Better readme for usageGravatar Jimmi Holst Christensen2020-03-051-11/+2
| |
| * Add clap.usageGravatar Jimmi Holst Christensen2020-03-051-0/+43
| |
* | rebuild readmeGravatar joachimschmidt5572020-04-111-5/+4
| |
* | update for latest zig (varargs is no more)Gravatar dbandstra2019-12-091-9/+9
| |
* | update for latest zigGravatar dbandstra2019-12-011-6/+6
|/
* Add clap.parse as the simplest way of using the libGravatar Jimmi Holst Christensen2019-11-271-64/+96
|
* Breaking: OsIterator will now get the exe on initGravatar Jimmi Holst Christensen2019-11-091-10/+4
|
* correct comptime-clap-error.zig exampleGravatar Jimmi Holst Christensen2019-08-171-7/+5
|
* rebuild readmeGravatar Jimmi Holst Christensen2019-08-171-0/+2
|
* make help message look more like other toolsGravatar Jimmi Holst Christensen2019-08-171-3/+3
|
* adds parseParamGravatar Jimmi Holst Christensen2019-08-171-25/+12
| | | | a less verbose way of getting a Param(Help).
* build with latest version of zigGravatar Jimmi Holst Christensen2019-08-061-17/+7
|
* Embed examples in README during buildGravatar Jimmi HC2019-06-211-74/+163
| | | | fixes #11
HIC SVNT DRACONES