From e2bb6e21e26680782efa9b70214e19578bddb5aa Mon Sep 17 00:00:00 2001
From: Alex 'AdUser' Z <ad_user@runbox.com>
Date: Tue, 7 Feb 2017 22:58:23 +1000
Subject: [PATCH] + README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..62b15e5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+Overview
+--------
+
+Tool for finding similar images on filesystem.
+
+Requirements
+------------
+
+Runtime:
+
+* libsimdb
+* libmagick
+
+Compile-time:
+
+* headers for libraries above
+* C compiler with -std=c99 support
+* cmake >= 2.6
+* checkinstall (optional)
+
+Build and install
+-----------------
+
+    cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release .
+    make
+    make test
+    sudo checkinstall -- make install
+
+Usage
+-----
+
+    simdb-fdupes -h
+    simdb-fdupes -v ~/images-dir/ | tee dups.txt