add example gallery

with reference gallery index

1 files changed, 21 insertions, 0 deletions

diff --git a/example/readme.md b/example/readme.md
new file mode 100644
index 0000000..11e20c1
--- /dev/null
+++ b/example/readme.md
@@ -0,0 +1,21 @@
+ldgallery example gallery
+=========================
+
+This directory contains an example source directory that _ldgallery_ can understand to generate a gallery.
+
+
+Content
+-------
+
+```
+./example
+├── _DSC8808-1.jpg           -- a picture
+├── _DSC8808-1.jpg.yaml      -- its associated sidecar metadata file
+├── Glacier 3000             -- a directory grouping gallery items
+│   ├── _DSC5475.jpg
+│   ├── _DSC5475.jpg.yaml
+│   ├── _DSC5542.jpg
+│   └── _DSC5542.jpg.yaml
+├── index.json               -- reference gallery index file
+└── readme.md                -- this README
+```