summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-11 10:43:19 +0300
committerPaul Buetow <paul@buetow.org>2026-06-11 10:43:19 +0300
commit1e7b394e56085a9cc33b8b8b64b094d5223e8853 (patch)
treed716db2d332904bb66f34572ec066d19170cd9cc /README.md
parentcbd3cf2be4ce50092ec4eb3f4b28d77c0aa044e4 (diff)
Add shuriken logo and generated favicon
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 31482e6..2918b5f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# photoalbum
+![Shuriken logo](assets/docs/shuriken-logo.svg)
+
photoalbum is a minimal Bash script for Unix like operating systems (such as Linux) to generate static web photo albums.
The resulting static photo album is pure HTML+CSS (without any JavaScript!).
@@ -20,10 +22,10 @@ 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`,
-`DATADIR`, or `SYSCONFDIR` when packaging or staging an install:
+`just install` installs `photoalbum` to `/usr/bin`, templates and static assets
+to `/usr/share/photoalbum`, and the default config to `/etc/default/photoalbum`.
+Override paths with `DESTDIR`, `PREFIX`, `BINDIR`, `DATADIR`, or `SYSCONFDIR`
+when packaging or staging an install:
```
DESTDIR="$PWD/pkg" PREFIX=/usr just install
@@ -106,6 +108,8 @@ Successful generation writes `photoalbum.json` into the output directory. This
metadata records the generator version and timestamp, config source, template
directory, supported source image and generated file counts, tarball status, and
effective settings useful for debugging a published album.
+Generation also writes `favicon.ico` into the output directory and the default
+templates link to it.
Normal generation preserves reusable generated artifacts from the previous
`DIST_DIR` while still rerendering HTML, random splash/background choices,