README

   1 galgen -- static images gallery generator
   2
   3 That generator is written on zsh and is aimed only to deal with JPEG XL
   4 and WebP image formats solely. JPEG XL is superior to any other format
   5 both in lossy and lossless modes. The only exception is screenshots
   6 encoded in lossless WebP (VP8L) format.
   7
   8 Just run that script inside the directory with .jxl/.webp files. For
   9 each file the small preview will be generated in lossy WebP format. Also
  10 corresponding HTML file is generated too, containing information about
  11 the picture and its metadata.
  12
  13 You can set the following environment variables:
  14 * PAGESIZE (100 by default)
  15 * ORDERING ("Om" by default, zsh glob notation)
  16 * STYLE (URL to CSS file, by default is none, no stylesheet link is set)
  17
  18 If it is JPEG XL, then, for compatibility reason with non-bleeding edge
  19 software, alternative format is generated too: either JPEG (if JPEG XL
  20 contains losslessly transcoded JPEG), or PNG (leaving off the alpha channel).
  21
  22 If image file has corresponding .txt/.html, then it will be included on
  23 HTML page.
  24
  25 All images are sorted my modification date and grouped by pages, linking
  26 them together. If directory contains ".txt"/".html", then it will be
  27 included on the first page.
  28
  29 Following external utilities are called: djxl, jxlinfo, exiftool,
  30 pamtopng, pnmscale, pngcrush, advpng, webpinfo, dwebp, cwebp.