summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-15 18:22:59 +0300
committerPaul Buetow <paul@buetow.org>2026-06-15 23:50:41 +0300
commit66a39be5271393b95cddae1bd61206eea8427934 (patch)
tree03ddf53621c02cbd5efa70e2112c6a0e6c626ce5
parentb684fa5113239e595ecd1ccbcbd267ebbed9e62d (diff)
docs: document the volatile ./cache EXIF directory
Explain in the README that the per-photo EXIF identify cache now lives in a volatile cache/ directory parallel to dist/: it is never deployed (--sync only publishes DIST_DIR), persists across runs (and across a removed/rebuilt dist) to skip the slow identify on unchanged photos, is left in place by --clean, and is cleared once by --force. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
-rw-r--r--README.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/README.md b/README.md
index b7dcf31..6095e57 100644
--- a/README.md
+++ b/README.md
@@ -115,9 +115,22 @@ templates link to it.
Normal generation preserves reusable generated artifacts from the previous
`DIST_DIR` while still rerendering HTML, random splash/background choices,
animation classes, timestamps, and shuffled preview order. Existing scaled
-photos, thumbnails, blurs, and cached EXIF identify output are reused when the
-source image is unchanged. Pass `--force` with `--generate` to skip that cache
-copy and rebuild all generated image artifacts and EXIF data from scratch.
+photos, thumbnails, and blurs are reused from the previous output when the source
+image is unchanged.
+
+The per-photo EXIF `identify` output is cached in a separate `cache/` directory
+created next to `DIST_DIR` (i.e. parallel to `dist/` in the working directory).
+This cache is volatile and safe to delete, is **not** part of the published
+output (it is never written into `DIST_DIR`, so `--sync` does not deploy it), and
+persists across runs even if `DIST_DIR` is removed or rebuilt. Because reading
+EXIF from full-size originals is the slowest part of generation, keeping this
+cache makes regenerating an album dramatically faster: an unchanged photo skips
+`identify` entirely. `--clean` removes `DIST_DIR` but leaves `cache/` in place;
+delete `cache/` by hand to force a full EXIF rebuild on the next run.
+
+Pass `--force` with `--generate` to rebuild all generated image artifacts and
+re-read every photo's EXIF from scratch (it clears `cache/` once up front, then
+repopulates it during the run).
The following long options override config values: