mirror of
https://github.com/simonmichael/hledger.git
synced 2024-11-07 21:15:19 +03:00
;bin: better script install instructions
This commit is contained in:
parent
caa004889b
commit
e2bccf8645
@ -1,13 +1,6 @@
|
||||
Miscellaneous hledger add-ons, bash scripts, example make rules, etc.
|
||||
|
||||
hledger-*.hs are example/experimental hledger [add-on commands],
|
||||
shipped as executable stack scripts.
|
||||
They are easiest to run reliably if you have [stack] in your PATH;
|
||||
they will install required dependencies and compile themselves as needed.
|
||||
(You can also run them with cabal or runghc, or compile them with ghc, if you take care of the dependencies.)
|
||||
|
||||
[add-on commands]: http://hledger.org/hledger.html#add-on-commands
|
||||
[stack]: https://www.fpcomplete.com/haskell/get-started
|
||||
The hledger-*.hs scripts here are example/experimental hledger [add-on commands], including:
|
||||
|
||||
- hledger-check.hs - check more complex account balance assertions
|
||||
- hledger-smooth.hs - an attempt at automatically splitting infrequent/irregular transactions
|
||||
@ -15,6 +8,15 @@ they will install required dependencies and compile themselves as needed.
|
||||
- hledger-combine-balances.hs - render two balance reports as single multi-column one
|
||||
- hledger-balance-as-budget.hs - use one balance report as the budget for the other one
|
||||
|
||||
Note these are not tested as much as the rest of hledger, and some of them may be only proof of concepts.
|
||||
|
||||
They are easiest to run reliably if you have [stack] in your $PATH;
|
||||
they will install required dependencies and compile themselves as needed.
|
||||
(You can also run them with cabal or runghc, or compile them with ghc, if you take care of the dependencies.)
|
||||
|
||||
[add-on commands]: http://hledger.org/hledger.html#add-on-commands
|
||||
[stack]: https://www.fpcomplete.com/haskell/get-started
|
||||
|
||||
## Installing a single script
|
||||
|
||||
$ curl -sO https://raw.githubusercontent.com/simonmichael/hledger/master/bin/hledger-check.hs
|
||||
@ -35,3 +37,4 @@ Note the `--`, which is required to separate script options from hledger options
|
||||
$ git clone https://github.com/simonmichael/hledger
|
||||
$ # add hledger/bin/ to your $PATH
|
||||
$ hledger # addons appear in command list
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user