From f37c7039e5c1808637352e19a78d03f913263cd5 Mon Sep 17 00:00:00 2001
From: Samuele Lorefice <samuelelorefice98@gmail.com>
Date: Mon, 7 Apr 2025 10:04:15 +0200
Subject: [PATCH] Added readme

---
 Readme.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..dc0c801
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,38 @@
+# SDF Tool
+
+*A signed distance fields-based tool to generate shadow transition maps*
+
+## Key features
+
+- float16 png output for reduced banding
+- Automatic CUDA/OpenCL GPU Acceleration for most of the process
+- *nix style command line interface
+
+## How to use:
+From command line: `SDFMapTool -D <directory_with_images> -i <image1.png;image2.png;...> -o <output_file_path.png> ...`
+
+Available options:
+
+```terminal
+
+  -d, --debug           Enable debug mode.
+
+  -D, --imgDirectory    Required. Input Images directory.
+
+  -i, --images          Required. Images file names separated by ';' and in the correct order.
+
+  -o, --output          Required. Output file path.
+
+  -b, --blur            How many blur iterations to run.
+
+  -r, --radius          Blur radius.
+
+  -s, --step            Blur step size.
+
+  --sigma               Blur sigma value (weighting).
+
+  --help                Display this help screen.
+
+  --version             Display version information.
+
+```
\ No newline at end of file