From 640337d4201323e8169acc397e2dabc65c351244 Mon Sep 17 00:00:00 2001
From: leca <leca@foxarmy.org>
Date: Tue, 3 Sep 2024 21:36:53 +0300
Subject: [PATCH] readme changes

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8863491..71f77fc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
-# checks-parser
+# Checks parser
+checks parser is a program that help parsing different formats of checks to csv.
 
-C++/QT desktop program for parsing checks to csv
+# Usage
+### Input
+Ways you can input a check to this programm:
+* Via image (it uses OCR(Optical Character Recognition) to parse check content. The picture of a check must be contrast and well-lined (text must be perpendicular to right and left borders of an image) enough in order to be parsed well.)
+* Via plaintext, copied from an E-Mail. Just copy&paste text from your email, pick a correct store type (autodetect is in my plans!) and parse.
+* Via E-Mail file (.eml) **[!NOT IMPLEMENTED YET!]**
+* Via QrCode on check (OFD (ОФД, Оператор Фискальных Данных in Russian)). **[!NOT IMPLEMENTED YET!]**
+
+### Output
+At the start of writing this program, I considered 3 or more output formats: csv, xlsx and ods. But throught the development I understood that most of modern table processor (i.e. electronic tables) can import csv much better than I'd be writing a shitty export module, adding more dependencies and shitty code to the codebase. So I decided that there's no need to use anything other than csv format. 
+
+To export, you need to specify an output file path and, if you wish, you can change order and/or rename columns, choose to print or not to print header (column names) and total.
+
+# Installing
+## Building
+In general, you need to install following dependencies in order to build that app(I suppose you have install all the build necessaries such as cmake, make, gcc, git, etc...):
+* tesseract (you also have to install appropriate for your needs language data)
+* opencv
+* curl
+* nlohmann-json
+* qt5
+
+Please, do not hesitate to open an issue if you cannot build that. I will help and if you are building on a distro that is not listed there, we can append that list as soon as we will solve your problem!
+### Linux
+##### Arch Linux
+I recommend using aur helper (I use yay) to install dependencies. Or, if you're masochist, you can build all by yourself /shrug
+```
+#Install dependencies
+yay -S sudo cmake git coreutils base-devel eigen qt5-base mbedtls gtkglext cpr opencv opencv2 nlohmann-json tesseract tesseract-data-rus
+#Clone and compile an app
+git clone https://git.foxarmy.org/leca/checks-parser
+cd checks-parser
+mkdir build
+cd build
+cmake ..
+make -j{nproc}
+#If you wish to install that program system-wide, run
+sudo make install
+```
+##### Debian
+TODO
+### Windows 
+Maybe
+### Mac OS
+Probably not, I do not have nor desire or time. But if you can maintain that program on Mac, I'd be grateful! Please, contact me, if you can!
+
+## Precompiled
+I plan to make precompiled binaries for Linux and Windows. Maybe I will put it on AUR. I also think that I will be making an AppImage