Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 3.69 KB

README.md

File metadata and controls

68 lines (43 loc) · 3.69 KB
Raw

favagtk

pipeline status Latest Development Release

Do your finances using fava and beancount.

favagtk makes it easy to use the Fava and Beancount double-entry bookkeeping software as a GNOME desktop application.

  • Easy installation using flatpak.

  • Start fava and beancount as you would any other desktop application.

  • Built as a GNOME application, using GTK and webkit, packaged using flatpak.

Screenshot

Screenshot of favagtk

Installation

favagtk can be installed from flathub.

Download on Flathub

System requirements:

  • A linux system with flatpak is needed to install and run the flatpak package.
  • The app's target platform is the GNOME desktop environment. (Other desktop environments are not targeted, but are likely to work as well).

Usage

Once installed, you will find an application named "Fava" that can be started in the very same way as any other desktop application, e.g., using GNOME Shell's activity view.

The application window that is initially shown prompts to open a beancount file. If you don't have a beancount file yet, you can simply create an empty text file with a .beancount extension. Alternatively, it is possible to generate an example beancount file by running beancount's bean-example command. Opening the beancount file will display fava's user interface, allowing to view and edit the beancount file.

Note that FavaGTK is only a thin convenience layer around Fava and Beancount. These two programs provide the actual functionality. You can find documentation on how to use these programs for managing your finances on their respective websites.

Contributing

favagtk is developed in an open-source, community-driven way, as a voluntary effort in the authors' free time.

All contributions are greatly appreciated... pull requests are welcome, and so are bug reports and suggestions for improvement. See CONTRIBUTING.md for details, e.g., how to view debug output when testing and how to setup a development environment.

License

favagtk is GPL-licensed, see the COPYING file.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Licenses of packages that favagtk depends on: Most of favagtk's functionality comes from other software packages; many thanks in particular to the authors of Fava and Beancount. See the requirements folder for a list of software packages that favagtk depends on.