leca/checks-parser
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity

added russian readme

Browse Source
This commit is contained in:
leca
2024-12-09 17:06:35 +03:00
parent 2ebcf68838
commit baa8ae6e65
2 changed files with 112 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,10 +1,14 @@
-->[Русская версия](https://git.foxarmy.org/leca/checks-parser/src/branch/master/README.ru.md)<-->
# Checks parser
checks parser is a program that help parsing different checks to csv.
!!!CURRENTLY SUPPORTED ONLY RUSSIAN CHECKS!!!
To know why, see [this section](#Checks-from-different-countries)
To know why, see [this section](https://git.foxarmy.org/leca/checks-parser#checks-from-different-countries)
# Usage
For more detailed description, please, refer to [the wiki](https://git.foxarmy.org/leca/checks-parser/wiki/Description-%5BEN%5D)
### 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.) OCR is not a magic wand :(
@@ -30,7 +34,7 @@ In general, you need to install following dependencies in order to build that ap
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-based
I recommend using aur helper (I use yay) to install dependencies. Or, if you're masochist, you can build all by yourself /shrug
I recommend using aur helper (I use yay) to install dependencies. Or, if you're masochist, you can build all by yourself ¯\\\_(ツ)\_/¯
```
#Install dependencies
yay -S base-devel qt5-base opencv zbar nlohmann-json tesseract
@@ -65,7 +69,7 @@ sudo make install
```
### Windows
See [Precompiled binaries](#Precompiled-binaries)
See [Precompiled binaries](https://git.foxarmy.org/leca/checks-parser#precompiled-binaries)
### 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!
@@ -76,7 +80,7 @@ Every new release will certainly contain AppImage and tarball. I am working towa
# Special thanks
HyperFlint (@hyperflint:foxarmy.org) - for the great idea to use OFD!
HyperFlint (@hyperflint:foxarmy.org) - for the great idea to use OFD and a huge help in release preparations!
https://check.ofd.ru - for providing a way to request data from FNS.