simple_gallery

commit 88e7954be8f6ebe7113c3d79f78467fb590f2697
parent b9cff911271ff6043577db495ee336008a200d42
Author: sej <sej@sejdt.localhost>
Date:   Mon, 30 Sep 2024 18:39:34 +0200

Added readme with short description of requirements and how it works.

Diffstat:
A
README.md
 | 
27
+++++++++++++++++++++++++++

1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+simple gallery
+==============
+
+> Generate a static multi-album image gallery HTML/CSS site from a JSON description.
+
+Requirements
+------------
+
+ - [exiftool](https://exiftool.org/) is needed for the extraction of metadata from photos.
+ - [mogrify from ImageMagick](https://imagemagick.org/script/mogrify.php) is needed for the generation of thumbnails.
+ - python3 and [jinja](https://jinja.palletsprojects.com/) for the generation of the HTML.
+
+Example Usage
+-------------
+
+TODO
+
+Note: Make sure every image in the JSON album actually exists in the input image folder.
+
+Even if an image is not in the JSON album the 
+
+Images, Thumbnails & Metadata
+---------------------
+
+Source images are copied to the destination with metadata stripped to only include date, camera settings, camera model, lens model, artist and copyright information.
+Metadata is also written in csv format to the folder img/metadata. This can be deleted after running ```gallery_builder.sh```.
+Thumbnails are 70% jpeg quality 1/8 resolution of the original, while previews are 80% 1/2 resolution.