2023-12-14 22:23:43 +00:00
# Perfin
2024-01-02 02:48:14 +00:00
2023-12-14 22:23:43 +00:00
2023-12-14 23:29:03 +00:00
A personal accounting desktop app to track your finances using an approachable
interface and interoperable file formats for maximum compatibility.
2024-01-05 02:55:56 +00:00
2024-01-02 02:48:14 +00:00
## Download
Head to the [releases ](https://github.com/andrewlalis/perfin/releases ) page and
find the installer that's compatible for your system.
> No compatible release for your system? [Report it here.](https://github.com/andrewlalis/perfin/issues)
2023-12-14 23:29:03 +00:00
## About Perfin
2023-12-28 17:57:03 +00:00
Perfin is a desktop app built with Java 21 and JavaFX. It's intended to be used
by individuals to track their finances across multiple accounts (savings,
checking, credit, etc.).
2023-12-17 00:48:04 +00:00
Because the app lives and works entirely on your local computer, you can rest
assured that your data remains completely private.
2023-12-28 17:57:03 +00:00
Currently, the application is still a work-in-progress, and is not yet suitable
for actual usage with your real financial data, so stay tuned for updates.
2024-01-05 02:52:53 +00:00
# Release Procedure
Platform-specific package installers are generated automatically via GitHub
Actions (see `.github/workflows/make-release.yaml` ), which is triggered by a
new tag being pushed to the `main` branch. Follow these steps to push a release:
1. Run `java scripts/SetVersion.java 1.2.3` (replacing `1.2.3` with the new version number)
to set the version everywhere that it needs to be.
2. Add a tag to the `main` branch with `git tag v1.2.3` .
3. Push the tag to GitHub with `git push origin v1.2.3` .
Once that's done, the workflow will start, and you should see a release appear
in the next few minutes.
