From 8b8e40523f999fa2e2d676f591ac85c60f063083 Mon Sep 17 00:00:00 2001 From: Soccera1 <129828376+Soccera1@users.noreply.github.com> Date: Mon, 13 Jul 2026 20:02:06 +1000 Subject: Add friendlier error messages --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 1d6ea28..801c0ba 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,23 @@ The top-level `--help` output lists the available commands. Use ## Compatibility +BNU keeps the familiar GNU diagnostic as the first line of an error, then adds +an actionable `Hint:`. Command-aware remedies cover option syntax, operands, +formats, ranges, modes, filesystems, processes, and uncommon platform failures; +a general next step remains as a final fallback. Set `GNULY_CORRECT` to +a truthy value such as `1` or `true` to emit GNU-compatible diagnostics exactly. +Boolean names are case-insensitive, so `True` and `TRUE` work too: + +```sh +GNULY_CORRECT=1 bnu cat missing-file +``` + +An empty value, `0`, or any capitalization of `false` disables GNU-compatible +wording and leaves friendly hints enabled. + +This switch affects diagnostic wording only; it does not change command +semantics. It is enabled automatically by BNU's GNU compatibility test harness. + The compatibility target is the observable command-line behavior of GNU coreutils 9.11. The upstream package contains 733 command-test scripts; BNU has passing test results for 727 of them. The other six cannot start the Bun runtime -- cgit v1.3