X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fhomebank2ledger;a=blobdiff_plain;f=README.md;h=c897fd8a8c71931a91fe5f38b6d55181104357b7;hp=1b1b430a689d4b1f082faf8c9f1c85add7764753;hb=27025d09184ff545b6e596f3982ce76fcc5eae78;hpb=6a0c8255851926b87379ca6b1e62bd78e631db37 diff --git a/README.md b/README.md index 1b1b430..c897fd8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ homebank2ledger - A tool to convert HomeBank files to Ledger format # VERSION -version 0.005 +version 0.006 # SYNOPSIS @@ -48,6 +48,43 @@ You can migrate the data you have in HomeBank so you can start maintaining your Or if you don't plan to switch completely off of HomeBank, you can continue to maintain your accounts in HomeBank and use this script to also take advantage of the reports Ledger offers. +# INSTALL + +There are several ways to install `homebank2ledger` to your system. + +## using cpanm + +You can install `homebank2ledger` using [cpanm](https://metacpan.org/pod/cpanm). If you have a local perl (plenv, perlbrew, etc.), +you can just do: + + cpanm App::Homebank2Ledger + +to install the `homebank2ledger` executable and its dependencies. The executable will be installed +to your perl's bin path, like `~/perl5/perlbrew/bin/homebank2ledger`. + +If you're installing to your system perl, you can do: + + cpanm --sudo App::Homebank2Ledger + +to install the `homebank2ledger` executable to a system directory, like +`/usr/local/bin/homebank2ledger` (depending on your perl). + +## Downloading just the executable + +You may also choose to download `homebank2ledger` as a single executable, like this: + + curl -OL https://raw.githubusercontent.com/chazmcgarvey/homebank2ledger/solo/homebank2ledger + chmod +x homebank2ledger + +## For developers + +If you're a developer and want to hack on the source, clone the repository and pull the +dependencies: + + git clone https://github.com/chazmcgarvey/homebank2ledger.git + cd homebank2ledger + make bootstrap # installs dependencies; requires cpanm + # OPTIONS ## --version