diff options
| author | Soccera1 <[email protected]> | 2026-07-28 15:54:54 +1000 |
|---|---|---|
| committer | Soccera1 <[email protected]> | 2026-07-28 15:54:54 +1000 |
| commit | 6a2f098e72e71437154ec00506e8e736aa8e1026 (patch) | |
| tree | 63e9f5596be38558dbeb40bb566735759a3ccabb /README.md | |
| parent | a753f669c9bedfccb9f7f400da018bb487dca5d0 (diff) | |
| download | bnu-6a2f098e72e71437154ec00506e8e736aa8e1026.tar.gz bnu-6a2f098e72e71437154ec00506e8e736aa8e1026.zip | |
Add docs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -46,6 +46,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 @@ -109,6 +123,8 @@ matrix are documented in [Testing](docs/testing.md). - `bin/bnu.js` — multi-call entry point - `src/coreutils.js` — command implementations +- `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 |
