From 399c2d409a9d7524a5a78b538ea381149d5ebaf1 Mon Sep 17 00:00:00 2001
From: "iliya.saroukha" <iliya.saroukhanian@etu.hesge.ch>
Date: Fri, 18 Apr 2025 14:30:23 +0200
Subject: [PATCH] feat: added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..19d0b7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+## Prerequisites
+
+### Create a `python` virtual environment
+
+```bash
+python3 -m venv .venv
+```
+
+### Activate the virtual environment
+
+```bash
+source .venv/bin/activate
+```
+
+### Installing the dependencies
+
+```bash
+pip3 install -r requirements.txt
+```
+
+## Running the program
+
+```bash
+python3 dct.py ./resources/forest.png
+```
+
+## Example result
+
+![Visual output of the program](./report/figs/example_output.png) 
-- 
GitLab