]> Sergey Matveev's repositories - galgen.git/blobdiff - README
.info is not publicy interesting
[galgen.git] / README
diff --git a/README b/README
index eb3e410f168ef84fee3497a016c1202d69e3ff3c..5dfe7f190068a3c8771c7394ae91396e4ff5fee8 100644 (file)
--- a/README
+++ b/README
@@ -2,24 +2,29 @@ galgen -- static images gallery generator
 
 That generator is written on zsh and is aimed only to deal with JPEG XL
 and WebP image formats solely. JPEG XL is superior to any other format
-both in lossy and lossless modes. The only exception is screenshots
-encoded in lossless WebP (VP8L) format.
+both in lossy and lossless modes. WebP just can not be losslessly
+transcoded to JPEG XL, so it is left for backward compatibility.
 
 Just run that script inside the directory with .jxl/.webp files. For
 each file the small preview will be generated in lossy WebP format. Also
 corresponding HTML file is generated too, containing information about
 the picture and its metadata.
 
+You can set the following environment variables:
+* PAGESIZE (100 by default)
+* ORDERING ("Om" by default, zsh glob notation)
+* STYLE (URL to CSS file, by default is none, no stylesheet link is set)
+
 If it is JPEG XL, then, for compatibility reason with non-bleeding edge
 software, alternative format is generated too: either JPEG (if JPEG XL
 contains losslessly transcoded JPEG), or PNG (leaving off the alpha channel).
 
-If image file has corresponding .txt, then it will be included as a
-preformatted text on HTML page.
+If image file has corresponding .txt/.html, then it will be included on
+HTML page.
 
-All images are sorted my modification date and grouped by pages,
-linking them together. If directory contains ".txt", then it will be
-included on the first page as a preformatted text.
+All images are sorted my modification date and grouped by pages, linking
+them together. If directory contains ".txt"/".html", then it will be
+included on the first page.
 
 Following external utilities are called: djxl, jxlinfo, exiftool,
-pamtopng, pnmscale, pngcrush, advpng, webpinfo, dwebp, cwebp.
+pamtopng, pnmscale, pngcrush, advpng, webpinfo, dwebp, cwebp, parallel.