about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorCase Duckworth2019-07-01 17:41:01 -0500
committerCase Duckworth2019-07-01 17:41:01 -0500
commit237642e64e2425d9c1621294eb38eac1754c6f2c (patch)
tree0b1b117b369228b1894c145fb10f4d2e7c1a7301
parentUpdate file extensions (diff)
downloadunk-237642e64e2425d9c1621294eb38eac1754c6f2c.tar.gz
unk-237642e64e2425d9c1621294eb38eac1754c6f2c.zip
Add installing and running section
-rw-r--r--README.md25
1 files changed, 21 insertions, 4 deletions
diff --git a/README.md b/README.md index 517bb85..3eea2b2 100644 --- a/README.md +++ b/README.md
@@ -18,10 +18,27 @@ There are three main scripts:
18</ul> 18</ul>
19 19
20You are, of course, free to make the template file as large 20You are, of course, free to make the template file as large
21and involved as you like, but it's pretty good already: it has a plain 21and involved as you like, but it's pretty good already:
22(based on <a href="https://jrl.ninja/etc/1/">this article</a>) default CSS, 22
23or will use `S/s.css`, and it automatically adds a list of posts to 23<ul>
24the index, or a *return* link to other pages. 24 <li>it has a plain default CSS
25 (based on <a href="https://jrl.ninja/etc/1/">this article</a>),
26 or will use <code>S/s.css</code> if it exists</li>
27 <li>it automatically adds a list of posts to the index page,
28 or a <em.return</em> link to other pages</li>
29 <li>it cleans up the first line of the input file and makes it a
30 <code>&lt;title&gt;</code>, and a <code>&lt;h1&gt;</code>
31 in the generated HTML</li>
32</ul>
33
34<h1>INSTALLING &amp; RUNNING</h1>
35
36To install __UNK__, simply clone this repo and put it where you want it.
37The default __TM__ needs __LHT__ to be in the same directory as it,
38so keep that in mind.
39
40To run __UNK__, just `cd` into your cloned repo and run `./unk`.
41It's just a POSIX shell script.
25 42
26<h1>DETAILS</h1> 43<h1>DETAILS</h1>
27 44