From 8acb43e8056b44e05fd84bba71741f4381e9a0a7 Mon Sep 17 00:00:00 2001
From: Laurent Peuch <cortex@worlddomination.be>
Date: Wed, 3 Feb 2016 22:29:54 +0100
Subject: [PATCH] [doc] example doc

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index 071d5ad..240712f 100644
--- a/README.md
+++ b/README.md
@@ -201,6 +201,55 @@ How to use it:
     image: 7.jpg
 ```
 
+### Example
+
+As a recap, here is how the files of the example gallery are organised:
+
+```
+example
+      ├── settings.yaml
+      └── first_gallery
+          ├── settings.yaml
+          └── stuff.png
+```
+
+The content of <code>example/settings.yaml</code>:
+
+```
+title: "Example gallery"
+```
+
+The content of <code>example/first_gallery/settings.yaml</code>:
+
+```
+title: my first gallery
+sub_title: some subtitle
+date: 2015-12-08
+cover: stuff.png
+sections:
+  - type: full-picture
+    image: stuff.png
+    text:
+      title: Beautiful Title
+      sub_title: pouet pouet
+      date: 2015-12-08
+  - type: bordered-picture
+    image: stuff.png
+  - type: text
+    text: « voici plein de blabla à rajouter et <b>ceci est du gras</b> et encore plein plein plein plein de text car je veux voir comment ça va wrapper car c'est important et il faut pas que j'oublie de mettre des margins en % sinon ça va pas le faire alala là ça devrait aller »
+  - type: pictures-group
+    images:
+      -
+        - stuff.png
+        - stuff.png
+        - stuff.png
+      -
+        - stuff.png
+        - stuff.png
+  - type: full-picture
+    image: stuff.png
+```
+
 ## Build the website
 
 **Note: You need to be in an activated virtualenv.**