From f312cb79829e081132aa2eb7ac2d07b08fd3090a Mon Sep 17 00:00:00 2001
From: Ashik K <root@ashik.se>
Date: Sat, 11 Mar 2023 15:39:54 +0100
Subject: [PATCH] Add README

---
 README | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..b4cf6ba
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+Dependencies: curlpp, rapidjson
+
+To build please do:
+
+mkdir build
+cd build
+cmake ..
+make
+
+How to use?
+-----------
+1. First run the fetch_all binary with your api key as argument.
+  It will fetch the json data into your local folder.
+
+2. Run parser with argument "--download" (this will
+  download all the images).
+
+3. Run the "genexifall" script- Supply the folder name
+  containing the dwnloaded images as parameter.
+
+4. Run parser again without any arguments.
+   You should get the out.csv file generated at this step
+  (This is the file that you can use to import the data on OpenRefine).
+