summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-05 15:42:12 +0300
committerPaul Buetow <paul@buetow.org>2026-06-05 15:42:12 +0300
commita7954db7e70c47d137e957b1a7ca0c9e0f85bdf3 (patch)
treee8525aa4b6ef4dec300f9da699dc67ee6081ff48 /README.md
parent3cf33952612d27f48258d4084f5d651d01931613 (diff)
Retire Makefile and parallelize image processing
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index 13d25df..a488b02 100644
--- a/README.md
+++ b/README.md
@@ -30,9 +30,7 @@ DESTDIR="$PWD/pkg" PREFIX=/usr just install
DESTDIR="$PWD/pkg" PREFIX=/usr just deinstall
```
-`just uninstall` is an alias for `just deinstall`. The legacy Makefile forwards
-the same targets to `just`, so `make test` remains available for existing
-automation.
+`just uninstall` is an alias for `just deinstall`.
ImageMagick must also be installed. The script prefers the
modern `magick` command and falls back to `convert` when needed.
@@ -68,7 +66,8 @@ missing, run `photoalbum --init` first.
The config file is a Bash file with assignments such as `INCOMING_DIR`,
`DIST_DIR`, `TEMPLATE_DIR`, `TITLE`, `HEIGHT`, `THUMBHEIGHT`, `MAXPREVIEWS`,
-`RANDOM_SEED`, `SHUFFLE`, `SPLASH_PAGE`, and `TARBALL_INCLUDE`.
+`IMAGE_JOBS`, `RANDOM_SEED`, `SHUFFLE`, `SPLASH_PAGE`, and
+`TARBALL_INCLUDE`.
Before generating, `photoalbum` validates the loaded config and command-line
overrides. It checks required values, positive integer settings, `yes`/`no`
@@ -87,7 +86,8 @@ tarball filename uses `<timestamp>` as a placeholder so the output is stable.
`--print-config` writes stable shell-style assignments to stdout in this order:
`CONFIG_SOURCE`, `INCOMING_DIR`, `DIST_DIR`, `TEMPLATE_DIR`, `TITLE`, `HEIGHT`,
-`THUMBHEIGHT`, `MAXPREVIEWS`, `RANDOM_SEED`, `SHUFFLE`, `SPLASH_PAGE`,
+`THUMBHEIGHT`, `MAXPREVIEWS`, `IMAGE_JOBS`, `RANDOM_SEED`, `SHUFFLE`,
+`SPLASH_PAGE`,
`TARBALL_INCLUDE`, `TARBALL_SUFFIX`, `TAR_OPTS`, and `ORIGINAL_BASEPATH`.
Scalar values use Bash `%q` quoting and `TAR_OPTS` is normalized to a Bash array
assignment, so the output can be parsed by shell tooling. `--quiet` does not
@@ -110,6 +110,7 @@ The following long options override config values:
| `--height VALUE` | `HEIGHT` |
| `--thumbheight VALUE` | `THUMBHEIGHT` |
| `--maxpreviews N` | `MAXPREVIEWS` |
+| `--image-jobs N` | `IMAGE_JOBS` |
| `--random-seed VALUE` | `RANDOM_SEED` |
| `--shuffle` | `SHUFFLE=yes` |
| `--no-shuffle` | `SHUFFLE=no` |
@@ -139,6 +140,10 @@ effective paths, skipped existing files, staging output directory, and tarball
decisions. If `--quiet` and `--verbose` are repeated or combined, the last output
flag wins.
+ImageMagick photo processing runs in parallel. The default is `IMAGE_JOBS=3`.
+Set `IMAGE_JOBS` in the config, or pass `--image-jobs N`, to tune the number of
+concurrent ImageMagick jobs.
+
## Example usage
1. Run `photoalbum --init`.