From f82c09b9070ebb576638ab7504f21b697e2eecfc Mon Sep 17 00:00:00 2001
From: Case Duckworth
Date: Mon, 1 Jul 2019 16:54:16 -0500
Subject: Update README
---
README.md | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index ef7f827..ea34785 100644
--- a/README.md
+++ b/README.md
@@ -9,19 +9,19 @@ that all fits with 1000 bytes.
There are three main scripts:
- - UNK, a bash script that applies the template
- to each page and publishes them to the output dir,
- - LHT, an awk script that serves as a (very) basic
- markup language, and
- - TM,
+
- UNK (250 bytes), a bash 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 (509 bytes),
the default template script for UNK.
-__UNK__ and __LHT__ are 250 bytes each, for a total of 500 bytes.
-__TM__ takes up the remaining 500 bytes
-of the target 1000 bytes.
You are, of course, free to make the template file as large
-and involved as you like.
+and involved as you like, but it's pretty good already: it has a plain
+(based on this article) default CSS,
+or will use `S/css.css`, and it automatically adds a list of posts to
+the index, or a *return* link to other pages.
DETAILS
@@ -52,18 +52,14 @@ Content goes into the following (hard-coded) directories:
If there is no __TM__ in the directory where __UNK__ is run,
one will be created that will simply `cat` the file being processed.
-The following variables are made available to __TM__:
+The following variable is made available to __TM__:
- FN: the FileName
(with directories removed) of the file being processed
- - TT: the TiTle
- (the first line) of the file
- - BD: the BoDy
- (the rest) of the file
-as well as this function:
+as well as these functions:
- X, for eXpand:
@@ -73,6 +69,10 @@ as well as this function:
(or if it nests templates, one of the nested ones)
has a
ZZ
on a line by itself,
due to its heredoc
nature.
+ - T, for Title:
+ it'll return the first line of the current file.
+ - B, for Body:
+ it'll return all lines *but* the first of the current file.
and these aliases (though they're more an artefact of saving space
--
cgit 1.4.1-21-gabe81