From 0e26cb574782197d1ac54e3c023325abd9abfe2b Mon Sep 17 00:00:00 2001
From: Conor Kennedy <conor.kennedy@arm.com>
Date: Mon, 13 May 2019 09:03:22 +0100
Subject: IVGCVSW-3070 Add Documentation for ImageTensorGenerator &
 ImageCSVFileGenerator

Signed-off-by: Conor Kennedy <conor.kennedy@arm.com>
Change-Id: I071225a812e6f85b6abe83172be71913186523f4
---
 tests/ImageCSVFileGenerator/README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 tests/ImageCSVFileGenerator/README.md

(limited to 'tests/ImageCSVFileGenerator/README.md')

diff --git a/tests/ImageCSVFileGenerator/README.md b/tests/ImageCSVFileGenerator/README.md
new file mode 100644
index 0000000000..98857cb90a
--- /dev/null
+++ b/tests/ImageCSVFileGenerator/README.md
@@ -0,0 +1,13 @@
+# The ImageCSVFileGenerator
+
+The `ImageCSVFileGenerator` is a program for creating a CSV file that contains a list of .raw tensor files. These
+.raw tensor files can be generated using the`ImageTensorGenerator`.
+
+|Cmd:|||
+| ---|---|---|
+| -h | --help    | Display help messages |
+| -i | --indir   | Directory that .raw files are stored in |
+| -o | --outfile | Output CSV file path |
+
+Example usage: <br>
+<code>./ImageCSVFileGenerator -i /path/to/directory/ -o /output/path/csvfile.csv</code>
-- 
cgit v1.2.1