diff options
author | Case Duckworth | 2019-06-30 23:55:54 -0500 |
---|---|---|
committer | Case Duckworth | 2019-06-30 23:55:54 -0500 |
commit | d29f07145a02ce455d667e87405124e8797b71df (patch) | |
tree | d3e2e6500cb79d081433c5a14329d41f7aa11804 | |
parent | Change names and shorter head/tail (diff) | |
download | unk-d29f07145a02ce455d667e87405124e8797b71df.tar.gz unk-d29f07145a02ce455d667e87405124e8797b71df.zip |
Copyedit
-rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md index dc310d1..c25e751 100644 --- a/README.md +++ b/README.md | |||
@@ -9,20 +9,20 @@ that all fits with 1000 bytes. | |||
9 | There are three main scripts: | 9 | There are three main scripts: |
10 | 10 | ||
11 | - **UNK**, a bash script that applies the template | 11 | - **UNK**, a bash script that applies the template |
12 | to each page and publishes them to the output dir, and | 12 | to each page and publishes them to the output dir, |
13 | - **LHT**, an awk script that serves as a (very) basic | 13 | - **LHT**, an awk script that serves as a (very) basic |
14 | markup language. | 14 | markup language, and |
15 | - **TM**, the default template file for **UNK**. | 15 | - **TM**, the default template script for **UNK**. |
16 | 16 | ||
17 | Both scripts are 250 bytes each, for a total of 500 bytes. | 17 | **UNK** and **LHT** are 250 bytes each, for a total of 500 bytes. |
18 | The default template file takes up the remaining 500 bytes | 18 | **TM** takes up the remaining 500 bytes |
19 | of the target 1000 bytes. | 19 | of the target 1000 bytes. |
20 | You are, of course, free to make the template file as large | 20 | You are, of course, free to make the template file as large |
21 | and involved as you like. | 21 | and involved as you like. |
22 | 22 | ||
23 | # DETAILS | 23 | # DETAILS |
24 | 24 | ||
25 | ## UNK | 25 | ## unk |
26 | 26 | ||
27 | **UNK** takes a set of files in a directory, applies a template to them, | 27 | **UNK** takes a set of files in a directory, applies a template to them, |
28 | and output them into another directory as HTML files ready for a server. | 28 | and output them into another directory as HTML files ready for a server. |
@@ -33,7 +33,6 @@ each input file is read as a `heredoc`, which enables | |||
33 | shell interpolation. | 33 | shell interpolation. |
34 | So the template, as opposed to the engine, | 34 | So the template, as opposed to the engine, |
35 | can do all the heavy-lifting of index generation and navigation and such. | 35 | can do all the heavy-lifting of index generation and navigation and such. |
36 | That means all the | ||
37 | 36 | ||
38 | Content goes into the following (hard-coded) directories: | 37 | Content goes into the following (hard-coded) directories: |
39 | 38 | ||
@@ -43,7 +42,7 @@ Content goes into the following (hard-coded) directories: | |||
43 | to a server. | 42 | to a server. |
44 | 43 | ||
45 | If there is no **TM** in the directory where **UNK** is run, | 44 | If there is no **TM** in the directory where **UNK** is run, |
46 | one will be created that will simply echo the file being processed. | 45 | one will be created that will simply `cat` the file being processed. |
47 | 46 | ||
48 | The following variables are made available to **TM**: | 47 | The following variables are made available to **TM**: |
49 | 48 | ||
@@ -69,7 +68,7 @@ in the script, but they can be used in templates): | |||
69 | As mentioned above, templates can be nested. | 68 | As mentioned above, templates can be nested. |
70 | Simply call another template from **TM** with the **X** function. | 69 | Simply call another template from **TM** with the **X** function. |
71 | 70 | ||
72 | ## LHT | 71 | ## lht |
73 | 72 | ||
74 | **LHT** stands for *Less HyperText*, | 73 | **LHT** stands for *Less HyperText*, |
75 | because that's what you're writing when you're writing it | 74 | because that's what you're writing when you're writing it |
@@ -81,7 +80,7 @@ It also has support for three inline spans: | |||
81 | 80 | ||
82 | - `*em*` or `_em_` as *em* | 81 | - `*em*` or `_em_` as *em* |
83 | - `**strong**` or `__strong__` as **strong** | 82 | - `**strong**` or `__strong__` as **strong** |
84 | - `\`code\`` as `code`. | 83 | - `` `code` `` as `code`. |
85 | 84 | ||
86 | Everything else is just HTML. | 85 | Everything else is just HTML. |
87 | 86 | ||
@@ -119,7 +118,8 @@ So I just wrote the Really Important Parts: `<p>` and some inlines. | |||
119 | 118 | ||
120 | # LEGAL | 119 | # LEGAL |
121 | 120 | ||
122 | Copyright © 2019 Case Duckworth <acdw@acdw.net> | 121 | Copyright © 2019 Case Duckworth <<acdw@acdw.net>>. |
122 | |||
123 | This work is free. | 123 | This work is free. |
124 | You can redistribute it and/or modify it under the terms of | 124 | You can redistribute it and/or modify it under the terms of |
125 | the Do What The Fuck You Want To Public License, Version 2, | 125 | the Do What The Fuck You Want To Public License, Version 2, |