From: Lady <redacted>
Date: Sun, 28 Apr 2024 18:44:55 +0000 (-0400)
Subject: Update documentation to reflect usage on Linux
X-Git-Tag: 0.7.4~1
X-Git-Url: https://git.ladys.computer/Shushe/commitdiff_plain/dc9d0a5796562d876c30b8766fd9d544bfaf7b63

Update documentation to reflect usage on Linux
---

diff --git a/README.markdown b/README.markdown
index 5457ce7..e99255b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -21,9 +21,21 @@ It makes things easier by :⁠—
 - Enabling easy inclusion of source files within each other.
 
 It aims to do this with zero dependencies beyond the programs already
-  installed on your computer.
-(On Linux machines, you may need to install `libxml2-utils` to get the
-  commandline programs from `libxml2`.)
+  installed on your computer†.
+
+† The only non‐Posix programs‡ required are those provided by `libxml2`
+  and `libxslt` (which most operating systems provide), but on Linux
+  machines the commandline utilities may need to be installed
+  separately as **`libxml2-utils`** and **`xsltproc`**.
+Additionally, not all Linux distributions bundle all necessary Posix
+  programs; on Debian (for example) you may need to separately install
+  **`sharutils`** for `uudecode` and `uuencode` and **`pax`** for
+  archiving.
+
+‡ This make·file also currently depends on non‐Posix `stat` but
+  attempts to handle both the G·N·U and B·S·D variants.
+It expects `xargs` to accept a `-0` option, which, while widely
+  supported, is not a part of the Posix standard.
 
 **Note:**
 ⛩️📰 书社 requires functionality present in G·N·U Make 3.81 (or later)
@@ -123,9 +135,9 @@ In every case, you may supply your own implementation by overriding the
 - `git` (optional; set `GIT=` to disable)
 - `grep`
 - `ln`
-- `mkdir` (requires support for `-p`)
+- `mkdir`
 - `mv`
-- `od` (requires support for `-t x1`)
+- `od`
 - `pax` (only when generating archives)
 - `printf`
 - `rm`
@@ -134,9 +146,9 @@ In every case, you may supply your own implementation by overriding the
 - `stat` (BSD *or* GNU)
 - `test`
 - `touch`
-- `tr` (requires support for `-d`)
-- `uuencode` (requires support for `-m` and `-r`)
-- `uudecode` (requires support for `-m` and `-r`)
+- `tr`
+- `uuencode`
+- `uudecode`
 - `xargs` (requires support for `-0`)
 - `xmlcatalog` (provided by `libxml2`)
 - `xmllint` (provided by `libxml2`)