From c434f02745c7c7c223676d90b9c166f45659b19c Mon Sep 17 00:00:00 2001
From: askiiart <dev@askiiart.net>
Date: Sat, 19 Apr 2025 18:58:12 -0500
Subject: [PATCH] add readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cc032f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# My site
+
+## Site generation
+
+Pages are written as markdown files, then converted to HTML using `md2html.sh`, which converts them to pandoc and fixes some small bits (with `sed` and `regex-chicanery.py`). Then a new RSS feed and sitemap are generated using `generate-rss.sh` and `generate-sitemap.xml`.
+
+## Organization
+
+- Standard blog posts go in `/blog/`
+- Today I learned stuff goes in `/til/`
+- Misc data go in `/data/`
+- Assets (images, videos, etc) go in `/assets/`, lining up with the organization of the page they go to (e.g. `/blog/marlin-boot-animations.{md,html}` -> `/assets/blog/marlin-boot-animations/`)
+
+## Errors
+
+Error pages are provided by [http-status-codes](https://git.askiiart.net/askiiart/http-status-codes).