summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-04 15:13:05 +0300
committerPaul Buetow <paul@buetow.org>2026-06-04 15:13:05 +0300
commitade6c544dc474fd32378067b7b179580495fcb84 (patch)
tree2ab500780a815daa7fd72f8670fe51c44018b3b0 /README.md
parent688a2b313e6d20044e0d32c7fa6309d183f2400f (diff)
Enforce photoalbum generated script drift check (5j0)
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index e9feb9a..b828b48 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,13 @@ just build
sudo just install
```
+`bin/photoalbum` is a committed generated artifact for compatibility with
+existing checkouts and packaging. Its source of truth is `src/photoalbum.sh`
+rendered through the `VERSION` value in `Justfile`. Run `just build` after
+changing either file, and use `just check-generated` to verify that the tracked
+script has not drifted. `just test` and `just install` run that drift check
+before rebuilding so stale committed output is not hidden.
+
`just install` installs `photoalbum` to `/usr/bin`, templates to
`/usr/share/photoalbum/templates`, and the default config to
`/etc/default/photoalbum`. Override paths with `DESTDIR`, `PREFIX`, `BINDIR`,