X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fhomebank2ledger;a=blobdiff_plain;f=README;fp=README;h=7f25f535e94c214e62a353885e7f627bea7f7085;hp=220932963ff1569b29cd1e8ec123acc6b4a8059a;hb=8feecd3de0d3293f8a26c05fc880415aee283e12;hpb=7e41aec36980b1a053b9e54cfd6119a38dd819a3 diff --git a/README b/README index 2209329..7f25f53 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ NAME VERSION - version 0.005 + version 0.006 SYNOPSIS @@ -58,6 +58,45 @@ DESCRIPTION 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. 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