aboutsummaryrefslogtreecommitdiff
path: root/doc/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 /doc/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 'doc/README.md')
-rw-r--r--doc/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..b4eac58
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,40 @@
+# BNU manual provenance
+
+The section-1 pages in [`man/`](../man/) and the Texinfo sources in this
+directory are adapted from the documentation in the GNU Coreutils 9.11 source
+release. The compiled [`bnu.info`](bnu.info) manual is generated from
+[`bnu.texi`](bnu.texi).
+
+The imported documentation retains the Free Software Foundation copyright,
+original author credits, warranty notice, and license notices. The Texinfo
+manual is distributed under the GNU Free Documentation License 1.3 or later,
+with no invariant sections or cover texts; its full license is included in
+[`fdl.texi`](fdl.texi). The upstream-generated manual pages state their
+GPLv3-or-later terms in each page.
+
+The BNU edition is marked as modified. Its substantive adaptations are:
+
+- BNU naming, version headers, bug-reporting URL, and local Info references
+- an explicit compatibility caveat for this independent Bun implementation
+- BNU's top-level and GNU-compatible multi-call invocation forms
+- standalone documentation for BNU's `sm3sum` extension
+- alias pages for `[` and `ginstall`, plus the local `bnu(1)` page
+- replacement of upstream C-implementation claims that do not apply to BNU
+
+The Info manual's title page, copyright notice, and History appendix identify
+the modified edition's contributors, publisher, date, and transparent sources
+as required by the GNU Free Documentation License.
+
+Most command and option descriptions remain upstream text because matching that
+observable interface is BNU's compatibility target. Platform-dependent behavior
+can still differ; command `--help` output and actual BNU behavior take precedence.
+
+To refresh the imported files from the release archive, install `tar`, Bun, and
+GNU Texinfo, place `coreutils-9.11.tar.xz` at the repository root, and run:
+
+```sh
+bun run docs:import
+```
+
+The importer overwrites upstream-derived section-1 pages and regenerates the
+Texinfo and Info files. The locally authored `man/bnu.1` page is preserved.