From ce1b0d862ff2af2067809a50e6454186a2a812af Mon Sep 17 00:00:00 2001 From: teutat3s Date: Fri, 15 Dec 2023 22:01:00 +0100 Subject: [PATCH] docs: update README --- README.md | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f3deb87..aaf61f7 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,42 @@ -Quick start +# pub.solar finances + +This repository is used to track the finances of pub.solar transparently. +We use [hledger](https://hledger.org/) to create finance report in a minimalistic, terminal friendly +way. + +### Quick start + +Installing hledger with [nix](https://nixos.org/download), the package manager. + ``` -nix shell latest#hledger latest#hledger-web +git clone gitea@git.pub.solar:pub-solar/finances.git finances && cd $_ +nix develop ``` -Report without negative numbers +or with [direnv](https://github.com/nix-community/nix-direnv). + +``` +git clone gitea@git.pub.solar:pub-solar/finances.git finances && cd $_ +direnv allow +``` + +Creating a report without negative numbers ``` hledger incomestatement --file ./finances.hledger --layout bare --pretty --drop 1 ``` -Web report for viewing it in a browser +Creating a web report, viewable in a browser ``` hledger-web --file ./finances.hledger ``` -Write HTML table to README +Writing a HTML table to the README ``` hledger incomestatement --file ./finances.hledger --layout bare --pretty --drop 1 -O html >> README.md ``` -Test generated report table +### Finances report table +