aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSoccera1 <[email protected]>2026-07-28 16:08:14 +1000
committerSoccera1 <[email protected]>2026-07-28 16:08:48 +1000
commit9846f087eb28bf11df740675ef487657ded39b69 (patch)
treee91dbd19b524f9432da6bcb86b1fc193e0d02e26 /README.md
parent7fa396c9ef22b32a0b05e94aaa0266dd3e7515f8 (diff)
parent6a2f098e72e71437154ec00506e8e736aa8e1026 (diff)
downloadbnu-refactor/single-call-commands.tar.gz
bnu-refactor/single-call-commands.zip
Merge branch 'master' into refactor/single-call-commandsrefactor/single-call-commands
# Conflicts: # README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0f69606..30f952b 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,20 @@ take precedence over the system coreutils.
The top-level `--help` output lists the available commands. Use
`COMMAND --help` for a command's accepted options.
+## Manuals
+
+BNU includes section-1 manual pages and an Info manual adapted from GNU
+Coreutils 9.11, with BNU-specific invocation, diagnostic, and extension notes.
+Read them directly from a checkout with:
+
+```sh
+man -l man/cat.1
+info -f doc/bnu.info
+```
+
+The manual sources, licensing, adaptations, and refresh procedure are described
+in [BNU manual provenance](doc/README.md).
+
## Compatibility
BNU keeps the familiar GNU diagnostic as the first line of an error, then adds
@@ -129,6 +143,8 @@ matrix are documented in [Testing](docs/testing.md).
- `src/shared/{common,filesystem,text,checksum,process,system}.js` — smaller cross-family primitives
- `src/coreutils.js` — compatibility export for API consumers
- `bin/bnu.js` — compatibility multi-call launcher
+- `man/` — adapted section-1 manual pages
+- `doc/` — adapted Texinfo sources and compiled Info manual
- `tests/` — local Bun tests
- `scripts/` — test harnesses, wrapper generation, and VM tooling
- `docs/` — testing and compatibility documentation