Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bios-Marcel committed Jul 21, 2024
1 parent f11d229 commit 46ed36c
Showing 1 changed file with 36 additions and 12 deletions.
48 changes: 36 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@ This application DOES NOT connect to your bank or your bank account in any way.
It uses Export-Formats offered by your bank. Currently, there are a couple of hard-coded ones that I am using for test
purposes. The plan is to have a configurable CSV importer, as most banks seem to offer CSV exporting.

Some banks, for example Revolut however, only offer a detailed export using PDF.
These can't be parsed and probably won't ever be supported. Just switch to a better bank ;)

## Requirements

* Windows 10+ (For now)
* Maven
* OpenJDK 22
* https://github.com/wixtoolset/wix3/releases

## Data Storage

For storage, we are using `Eclipse Store` (previously `MicroStream`). The data is stored in `$env.APPDATA`.
Expand All @@ -27,6 +17,8 @@ In order to delete the data, simply remove `$env.APPDATA/baka`.

## Installation

### Windows

An installer can be built via maven:

```shell
Expand All @@ -35,5 +27,37 @@ An installer can be built via maven:
./mvnw compile package javafx:jlink jpackage:jpackage
```

On Windows, the installer is a little buggy, as automatic reinstallation does not work.
To update, a manual deinstallation is required before installation.
Updating an existing installation does not work correctly as of now.
To update, a manual uninstallation is required before installation.

Pre-built installers are also available as build artifacts.

### Other systems

TODO

## Development

### Requirements

* Required
* Maven
* OpenJDK 22
* Optional
* Building a windows installer: https://github.com/wixtoolset/wix3/releases

### Setup

In order to get all dependencies and generated sources, run:

```shell
./mvnw -f antlr.xml dependency:get -Dartifact="org.antlr:antlr4-runtime:4.13.1:jar"
./mvnw -f antlr.xml generate-resources
./mvnw compile
```

If you are using an IDE (such as IntelliJ), regenerate required IDE resources and reload the project.

### Debug Mode

The debug mode offers additional (potentially dangerous) features. It can be toggled via `Ctrl + Shift + D`.

0 comments on commit 46ed36c

Please sign in to comment.