From dc63a4059b84bc7022b6753868a75af1f71c366c Mon Sep 17 00:00:00 2001
From: Callum Renwick <cren@tilde.team>
Date: Fri, 1 Jan 2021 17:25:09 +0000
Subject: [PATCH] Add LICENCE and README

---
 LICENCE |  5 +++++
 README  | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)
 create mode 100644 LICENCE
 create mode 100644 README

diff --git a/LICENCE b/LICENCE
new file mode 100644
index 0000000..8850d43
--- /dev/null
+++ b/LICENCE
@@ -0,0 +1,5 @@
+0BSD Licence
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
new file mode 100644
index 0000000..6be4053
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+# Wordpusher
+
+Push the writing stack.
+
+## Quick start
+
+0. `git clone https://tildegit.org/c-ren/wordpusher.git`
+1. `mkdir input`
+2. `mkdir output`
+3. `echo 'Hello world!' > input/index.md`
+4. `wordpusher/render_tree input output`
+
+You will want to edit `render_file` to change things that only apply to my
+deployment (the header that says "cren's website", for example). (Yes, I know
+that this is terrible practice. I will fix it.)
+
+## Usage
+
+### render_file
+
+`render_file` is a POSIX `sh` script that mostly consists of running `cmark` on
+a file.
+
+```
+render_file <input.md>
+```
+
+### render_tree
+
+`render_tree` is another `sh` script that calls `render_file` on every file
+in a directory, including every file in every directory in that directory (it's
+recursive). You must also provide an output directory.
+
+```
+render_tree <input_dir> <output_dir>
+```
+
+## Licence
+
+Made available under the 0BSD licence, a permissive free-as-in-freedom licence. See the included LICENCE file for full text.