X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/d10f14e9c634de864421e5e4bd81035be08f7bce..6a2e42ac0e7daa97ee0aecc72ddcff9b288470e2:/README.markdown?ds=sidebyside diff --git a/README.markdown b/README.markdown index 3801b7e..9d51889 100644 --- a/README.markdown +++ b/README.markdown @@ -1,6 +1,6 @@ # ⛩️📰 书社 -An X·S·L·T‐based static site generator. +A make·file for X·M·L. ⛩️📰 书社 aims to make it easy to generate websites with X·S·L·T and G·N·U Make. @@ -18,6 +18,15 @@ It makes things easier by :⁠— 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`.) + +**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. ## Nomenclature @@ -162,7 +171,7 @@ The following additional variables can be used to control the behaviour Rules to use with `find` when searching for source files. The default ignores files that start with a period or hyphen‐minus and those which contain a hash, buck, percent, asterisk, colon, - semi, eroteme, bracket, or pipe. + semi, eroteme, bracket, backslash, or pipe. - **`FINDINCLUDERULES`:** Rules to use with `find` when searching for includes (default: @@ -211,8 +220,8 @@ Source files whose media type does not have an associated X·S·L·T **☡ For compatibility with this program, source file·names must not contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`), bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets - (`[` or `]`), erotemes (`?`), or control characters, and must not - begin with a hyphen‐minus (`-`).** + (`[` or `]`), erotemes (`?`), backslashes (`\`), or control + characters, and must not begin with a hyphen‐minus (`-`).** The former characters have the potential to conflict with make syntax, and a leading hyphen‐minus is confusable for a command‐line argument. @@ -462,4 +471,4 @@ Source files are licensed under the terms of the Mozilla Public License, version 2.0. For more information, see [LICENSE](./LICENSE). -[draft-phillips-record-jar-01]: \ No newline at end of file +[draft-phillips-record-jar-01]: