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

readme changes

This commit is contained in:
leca 2024-12-07 02:18:03 +03:00
parent 7290769750
commit b135f8a94d
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -7,10 +7,9 @@ To know why, see [this section](#Checks-from-different-countries)
# 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 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 :(
* 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 a picture of a check. Be sure to make the image straight and sharp. OCR is not a magic wand :(
* Via QrCode on check (OFD (ОФД, Оператор Фискальных Данных in Russian)).
* Via QRCode on check (this method queries check content from OFD (ОФД, Оператор Фискальных Данных in Russian) (My program makes requests to ofd.ru)).
### 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.
@ -34,7 +33,9 @@ Please, do not hesitate to open an issue if you cannot build that. I will help a
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 opencv opencv2 zbar nlohmann-json tesseract tesseract-data-rus vtk
yay -S base-devel qt5-base opencv zbar nlohmann-json tesseract
#Install a language package for OCR. Replace ``LANG` to your language. For example, ``tesseract-data-rus`` for russian language
yay -S tesseract-data-LANG
#Clone and compile an app
git clone https://git.foxarmy.org/leca/checks-parser
cd checks-parser
@ -64,17 +65,21 @@ sudo make install
```
### Windows
Maybe
See [Precompiled binaries](#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!
## Precompiled binaries
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
Currently I have published the program to the [AUR](https://aur.archlinux.org/packages/checks-parser-git).
Every new release will certainly contain AppImage and tarball. I am working towards binaries for Windows and deb packets. Expect them to appear in next releases!
# Special thanks
HyperFlint (@hyperflint:foxarmy.org) - for the great idea to use OFD!
https://check.ofd.ru - for providing a way to request data from FNS.
# Contribution
If you want to contribute to the project, you can do it by some of the following:
@ -83,7 +88,7 @@ If you want to contribute to the project, you can do it by some of the following
I live in Russia and only know how Russian state checks system works. If you live in another country and want to help me with adding support to checks from your country - feel free to contact me!
## Issues and PRs
If you have found a bug, or want to suggest a feature - don't hesitate to open an issue / PR!
If you have found a bug, or want to suggest a feature - don't hesitate to open an issue / a PR!
## Tell friends