strips/jaarg
2
0
Fork 0
mirror of https://github.com/gay-pizza/jaarg.git synced 2025-12-19 07:20:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
a dinosaur
2025-11-05 21:00:11 +11:00
parent 67dc191443
commit 6158ae31d2
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,5 +1,7 @@
# jaarg argument parser library # # jaarg argument parser library #
nostd & (mostly) const, some say it can parse your arguments.
Dependency-free, const (mostly), no magic macros, `no_std` & no alloc (though nicer with those).
Some say it can parse your arguments.
### Obligatory fancy banners ### ### Obligatory fancy banners ###
<div> <div>
@@ -55,7 +57,12 @@ println!("{file:?} -> {out:?} (number: {number:?})",
### Changelog ### ### Changelog ###
<!-- main: --> main:
* Moved `Opts::parse_map` into newly introduced `alloc` crate, making it accessible for `no_std` users.
* API updates, enough public constructs to roll a custom help writer.
* Generalised internal error & usage into `StandardErrorUsageWriter` for reuse outside the easy API & in `no_std`.
* Fixed uncontrollable newlines in user display in easy API.
* More tests for validating internal behaviour.
v0.1.1: v0.1.1:
* Fixed incorrect error message format for coerced parsing errors. * Fixed incorrect error message format for coerced parsing errors.
@@ -65,6 +72,18 @@ v0.1.1:
v0.1.0: v0.1.0:
* Initial release. * Initial release.
### Roadmap ###
Near future:
* Actual `no_std` tests & examples.
* More control over parsing behaviour (getopt style, no special casing shorts for Windows style flags, etc.)
* More practical examples.
* CI on main GitHub.
Long term:
* Strategy for handling exclusive argument groups.
* Make use of const traits when they land to improve table setup.
### Projects using jaarg (very cool) ### ### Projects using jaarg (very cool) ###
<!-- soon... * [Sprout bootloader](https://github.com/edera-dev/sprout) --> <!-- soon... * [Sprout bootloader](https://github.com/edera-dev/sprout) -->
* [lbminfo](https://github.com/ScrelliCopter/colourcyclinginthehousetonight/tree/main/lbminfo) * [lbminfo](https://github.com/ScrelliCopter/colourcyclinginthehousetonight/tree/main/lbminfo)