commit e95ad3ef7c02a19a31f2df1e5269fc97a8446418
parent 6da7acdf677fba542c0e47a6042a9558d5a66687
Author: sej <sej@sejdt.localhost>
Date: Wed, 16 Oct 2024 14:02:17 +0200
Improved README
Diffstat:
| M | README.md | | | 36 | ++++++++++++++++++++++++++++++------ |
1 file changed, 30 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
@@ -13,14 +13,38 @@ Requirements
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
+ ./gallery_builder.sh <input_image_folder> <albums.json> <output_folder>
+
+Note that images in the input folder are not modified, instead are copied to the output folder.
+The script assumes that every image in the input JSON exists, so make sure every image in the JSON album actually exists in the input image folder.
+
+The albums.json is simply a JSON file with the following structure:
+
+ [
+ {
+ "name": "Album 1",
+ "imgs": [
+ "photo1.jpg",
+ "photo2.jpg"
+ "photo3.jpg"
+ "photo4.jpg"
+ ...
+ ]
+ },
+ {
+ "name": "Another Photo Album",
+ "imgs": [
+ "photo2.jpg"
+ ...
+ ]
+ },
+ ...
+ ]
+
+An image can exist in multiple albums and is only stored once. There are however multiple pages for the same image to preserve the album structure.
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```.
