From 1ae3e479862d8926eed493f5189b0fb04bb2dc9b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rostislav=20L=C3=A1n?= <lanrosta@seznam.cz>
Date: Sat, 10 Dec 2022 00:55:45 +0100
Subject: [PATCH] Added proper README.md

---
 README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 68 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1101322..ce3abdb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,68 @@
-# BP-DP-xlanro00
-Bakalářská práce 2022/2023
\ No newline at end of file
+
+# About this Project
+
+This project is being developed as a practical part of bachelor's thesis at Brno Universtiy of Technology - Faculty of Information Studies. It is as of now a work in progress, no results guaranteed.
+
+The topic of this thesis is Generating a 3D Fingerprint Model. This application can be used to apply series of image processing filters to a fingerprint image to make it more suitable for conversion to 3D stl model and printing.
+It should also have the functionality to convert the image to stl model.
+
+
+# Prerequisites
+
+For now this is only viable for ubuntu gnu/linux machines
+Before cloning repository, you need these to succesfully use the application.
+
+* python3.10 is a requirement
+    ```sh
+        apt install python3.10
+    ```
+* python graphical modules
+    ```sh
+        pip install numpy matplotlib opencv-python pillow
+    ```
+
+# Installation
+
+Installation is relatively fast and easy.
+
+1. Clone the repository
+    ```sh
+        git clone https://strade.fit.vutbr.cz/git/xlanro00/BP_DP-xlanro00
+    ```
+2. Prepare the image file with fingerprint, run the application
+
+# Usage
+
+There are two ways to enter filter series
+
+* manually from command line
+    ```sh
+        python src/main.py res/test_fp.png res/test_fp_cpy.png 100 blur
+    ```
+* manually from preset saved in a json config file, that can be used to create new presets 
+    ```sh
+        python src/main.py res/test_fp.png res/test_fp_cpy.png 100 --config config/config.json default_preset
+    ```
+
+# Roadmap
+
+- [x] Load and store image
+- [x] Apply basic image processing filters
+- [ ] Create filter library with more filters
+- [x] Use presets from config files
+- [ ] Make it a viable option to process an image
+- [ ] Convert image to stl format
+- [ ] Export final model ready for printing
+
+#
+### Author
+
+Rostislav Lán - xlanro00@stud.fit.vutbr.cz
+
+### Supervisor
+
+Ing. Petr Malaník
+
+### Links
+
+Project Link: [https://strade.fit.vutbr.cz/git/xlanro00/BP_DP-xlanro00](https://strade.fit.vutbr.cz/git/xlanro00/BP_DP-xlanro00)