From efd0912b29f7f3e73da128147f5b1e41ce71f9df Mon Sep 17 00:00:00 2001
From: Luis Araujo <luis.araujo@collabora.co.uk>
Date: Wed, 5 Dec 2018 18:52:30 +0800
Subject: [PATCH] Add instruction to attach images

This commit updates the README to explain how to attach images to
test case pages.

Signed-off-by: Luis Araujo <luis.araujo@collabora.co.uk>
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index ec788e0e..897dff68 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,12 @@ available: `macro_ostree_preconditions` , `macro_install_packages_preconditions`
 and `macro_modules_preconditions`. Please check the tests cases for example about
 how to use them.
 
+## Images
+
+Test cases can contain images. These are attached to a test case page starting a
+line in one of the special directives with the character `@` followed by the image
+name, then this image should be placed under the `renderer/images` directory.
+
 ## Renderer
 
 The main program is located inside the `renderer/` subdirectory and can be directly
-- 
GitLab