From 66c054ce70b24b18130e5685d1d4f1fe6ef47ec9 Mon Sep 17 00:00:00 2001
From: Alek Ratzloff <alekratz@gmail.com>
Date: Wed, 27 Apr 2022 15:03:24 -0700
Subject: [PATCH] Add README

Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e16401
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# fetch-achewood
+A pair of scripts that will fetch all Achewood comics and captions/alt-text, and then will reformat
+those comics and append the caption to the image.
+
+# Usage
+
+First, download achewood comics with `python3 fetch-achewood.py`. Requires Python 3.10+ and no
+additional libraries. All comics will be dumped into the `data/images/` directory.
+
+Second, run `./postprocess.sh`. This will convert all comics to png and add the caption to the
+bottom of the comic if it exists and dump them in the `out/` directory.