diff options
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f10197 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# xembu - eXtensiblE Multiuser Bookkeeping Utility + +This tool does simple bookkeeping statistics based on CSV input. + +## Installation + +1. Clone this repository and `cd` into the project directory. +2. Initialize python venv: `python -m venv .venv` +3. Activate venv: `source .venv/bin/activate` +4. Install requirements: `pip install -r requirements.txt` + +## Usage + +``` +usage: xembu.py [-h] [--title TITLE] [--pdf PDF] [--bundle BUNDLE] csv + +positional arguments: + csv CSV path + +options: + -h, --help show this help message and exit + --title, -t TITLE Title in PDF header (optional) + --pdf, -p PDF Target PDF path (optional) + --bundle, -b BUNDLE Path to bundle (.tar.zst), containing CSV, PDF and receipts (optional) +``` +``` + |