1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..132ab05
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# blogmirror
+
+Mirrors <https://blog.sillylaird.ca> into flat, mothra-friendly HTML under
+`html/`, in the same plain style as the rest of this site.
+
+It reads the blog's RSS feed (`/feed.xml.php`), which carries the full post
+body in `<content:encoded>`, so no HTML scraping is involved. Output:
+
+    html/index.html                     post list
+    html/YYYY/MM/DD/slug.html           one page per post
+
+## Build (9front)
+
+    mk
+
+`blogmirror.c` is plain ANSI C and builds with APE `pcc`; it also builds with
+`cc` on Linux/BSD for testing. Fetching uses `hget` when `/bin/hget` exists,
+`curl` otherwise.
+
+## Run
+
+    ./blogmirror                        mirror the live feed into html/
+    ./blogmirror -o /tmp/out            somewhere else
+    ./blogmirror -n 10                  only the newest 10 posts
+    ./blogmirror -f feed.rss            parse a feed already on disk
+    ./blogmirror -u URL                 a different feed
+
+## Refresh and publish
+
+    ./mirror.rc
+
+which regenerates `html/`, commits the changed files, and runs `git/push`.
+Requires `git/fs`, a loaded ssh key in factotum, and a remote already set in
+`.git/config`.