aboutsummaryrefslogtreecommitdiff
path: root/example/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'example/readme.md')
-rw-r--r--example/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/example/readme.md b/example/readme.md
new file mode 100644
index 0000000..d5a7563
--- /dev/null
+++ b/example/readme.md
@@ -0,0 +1,22 @@
1ldgallery example gallery
2=========================
3
4This directory contains an example source directory that _ldgallery_ can understand to generate a gallery.
5
6
7Content
8-------
9
10```
11./example
12├── _DSC8808-1.jpg -- a picture
13├── _DSC8808-1.jpg.yaml -- its associated sidecar metadata file
14├── Glacier 3000 -- a directory grouping gallery items
15│   ├── thumbnail.jpg -- a thumbnail for the "Glacier 3000" directory
16│   ├── _DSC5475.jpg
17│   ├── _DSC5475.jpg.yaml
18│   ├── _DSC5542.jpg
19│   └── _DSC5542.jpg.yaml
20├── gallery.yaml -- gallery settings file
21└── readme.md -- this README
22```