From ffc0d0b6fd68b949c8d8fd2dca99026b1f4c1cfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yaroslav=20de=20la=20Pe=C3=B1a=20Smirnov?= Date: Tue, 13 Oct 2020 00:38:44 +0300 Subject: Updated README Added information on how to build and install. --- README.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 949b6c6..387800b 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,37 @@ Quick cli tool to calculate your expenses and balance for a set period of time. ## TO-DO -* Take into account shared expenses -* Make AUR package * Make error messages more useful * Show what is being spent most money on * (Maybe) a way to interactively edit an input file ## How to install -For now the only way to install this, is by cloning or downloading the repo, and -building it from source with cargo: +You need to install the Rust toolchain (rustup, cargo, etc) to build this +program. You will also need scdoc to generate the manual pages, and make if you +want to automatically build and install the program. + +You can build it yourself using cargo: ``` cargo build --release ``` -From there, if you would like to have this program on your path, you can copy -it -- for example on Arch Linux -- to `/usr/bin/`. +Or build it and install it using make: + +``` +make +sudo make install +``` + +You can remove it by executing: + +``` +sudo make uninstall +``` + +For more information about the usage of this program, see `man 1 finbudg` and +`man 5 finbudg` after building and installing with make. ## Example -- cgit v1.2.3