]> Lady’s Gitweb - Shushe/blobdiff - README.markdown
Update readme
[Shushe] / README.markdown
index 8a0ebe1c26a8889c5a8112b553980eb277d7150a..f6874eaf462c9e275226568fea09f06fd7f1de42 100644 (file)
@@ -21,16 +21,28 @@ 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 (other than G·N·U Make itself,
+    and optionally Git) are those provided by `libxml2` and `libxslt`.
+On most operating systems, these libraries come pre·installed, but on
+  Linux machines the commandline utilities are often packaged
+  separately (as **`libxml2-utils`** and **`xsltproc`**), which may
+  still need to be installed.
+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)
-  and will not work in previous versions, or other implementations of
-  Make.
-Compatibility with later versions of G·N·U Make is assumed, but not
-  tested.
+⛩️📰 书社 requires functionality present in G·N·U Make 3.81 or later,
+  and will not work in previous versions, or with other implementations
+  of Make.
 
 ## Nomenclature
 
@@ -121,21 +133,22 @@ In every case, you may supply your own implementation by overriding the
 - `file`
 - `find`
 - `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`
 - `sed`
 - `sleep`
-- `stat`
+- `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`)
This page took 0.020746 seconds and 4 git commands to generate.