From a8a8004f8e040c4f77db2302901d04ed6f1644be Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Sat, 30 Jan 2021 15:33:58 -0600
Subject: Update README
---
README.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 309c0b7..12dcc90 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,11 @@ that all fits within 1000 bytes.
There are three main scripts:
- - UNK (253 bytes), a POSIX-sh script that applies
+
- UNK (239 bytes), a POSIX-sh script that applies
the template to each page and publishes them to the output dir,
- LHT (241 bytes), an awk script that serves as
a (very) basic markup language, and
- - TM (502 bytes),
+
- L (502 bytes),
the default template script for UNK.
@@ -37,7 +37,7 @@ and involved as you like, but it's pretty good already:
GITHUB MIRROR
To install __UNK__, simply clone this repo and put it where you want it.
-The default __TM__ needs __LHT__ to be in the same directory as it,
+The default __L__ needs __LHT__ to be in the same directory as it,
so keep that in mind.
To run __UNK__, just `cd` into your cloned repo and run `./unk`.
@@ -49,7 +49,7 @@ It's just a POSIX shell script.
__UNK__ takes a set of files in a directory, applies a template to them,
and output them into another directory as HTML files ready for a server.
-To keep a very small size, __UNK__ delegates most file processing to __TM__,
+To keep a very small size, __UNK__ delegates most file processing to __L__,
the main template. It delegates by using an idea found in
shab:
each input file is read as a `heredoc`, which enables
@@ -69,14 +69,14 @@ Content goes into the following (hard-coded) directories:
website, ready for rsync
ing to a server.
-If there is no __TM__ in the directory where __UNK__ is run,
+If there is no __L__ in the directory where __UNK__ is run,
one will be created that will simply `cat` the file being processed.
-The following variable is made available to __TM__:
+The following variable is made available to __L__:
- F: the File name passed to
- TM
+ L
- N: the fileName
(with directories removed) of the file being processed
@@ -89,7 +89,7 @@ as well as these functions:
It is much simpler than shab
,
and will fail if the template
(or if it nests templates, one of the nested ones)
- has a ZZ
on a line by itself,
+ has a ^D
on a line by itself,
due to its heredoc
nature.
T, for Title:
it'll return the first line of the current file.
@@ -107,7 +107,7 @@ in the script, but they can be used in templates):
As mentioned above, templates can be nested.
-Simply call another template from __TM__ with the __X__ function.
+Simply call another template from __L__ with the __X__ function.
lht
--
cgit 1.4.1-21-gabe81