From a31f754cfd62c58553173c56d89369a745b6f249 Mon Sep 17 00:00:00 2001 From: Andreas Tsouchlos Date: Wed, 3 Jan 2024 15:53:23 +0100 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f190aa1..e3b9394 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # banking-breakdown -Visualize bank statements. \ No newline at end of file +Visualize bank statements. + +## Usage + +1. Assign categories to bank statement entries: + ```bash + $ python -m banking_breakdown categorize -i [bank_statement.csv] -f [regex_file] + ``` +2. Generate report from categorized data: + ```bash + $ python -m banking_breakdown report -i [categorized.csv] + ``` + +## Other + +### Generate GUI from `*.ui` file + +```bash +$ pyuic6 res/main_window.ui -o banking_breakdown/ui/generated.py +``` \ No newline at end of file