Added a README

This commit is contained in:
2024-03-23 01:27:07 -04:00
parent e5c5c631ec
commit 3ca053a8e1
2 changed files with 31 additions and 5 deletions

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# coin
Something to coin the items on your receipts
## Why coin?
Because normal humans can't decipher what's on the Walmart receipts.
## How does coin work?
First, coins pulls the UPC and price info off of the given Walmart
receipt.
Then, coin matches the name with the UPC (Yes! No more scratching your
head against seemingly random Walmart abbreviations for items!) using
a scraper.
Finally, it stores your shopping trip in a spreadsheet (.csv format).
## Dependencies
- Python
- PyQt6
- pytesseract
- OpenCV (On Python)
- PIL
- Selenium (undetected, with a suitable chromedriver)

View File

@ -1,10 +1,10 @@
#+TITLE: coin - An inventory manager to keep track of items bought from Walmart (Canada)
#+TITLE: coin - Something to coin the items on your receipts
#+AUTHOR: Peisong Xiao
#+EMAIL: peisong.xiao.xps@gmail.com
#+OPTIONS: toc:nil date:nil
* Why coin?
If you'd like to keep track of your groceries, use coin.
Because normal humans can't decipher what's on the Walmart receipts.
* How does coin work?
First, coins pulls the UPC and price info off of the given Walmart
@ -12,9 +12,9 @@ receipt.
Then, coin matches the name with the UPC (Yes! No more scratching your
head against seemingly random Walmart abbreviations for items!) using
a scraper
a scraper.
Finally, it stores your shopping trip in a database.
Finally, it stores your shopping trip in a spreadsheet (.csv format).
* Dependencies
+ Python
@ -22,4 +22,4 @@ Finally, it stores your shopping trip in a database.
+ pytesseract
+ OpenCV (On Python)
+ PIL
+ Selenium (undetected)
+ Selenium (undetected, with a suitable chromedriver)