slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;bin: update readme (#1072)

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-07-16 23:37:45 +01:00
parent cb5334c8df
commit 64d6878d6c
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
bin/README.md
View File

@ -1,16 +1,20 @@
Miscellaneous hledger add-ons, bash scripts, example make rules, etc.
The Makefile may also store hledger developer binaries here.
hledger-*.hs are example/experimental hledger add-on commands, shipped as executable stack scripts.
Add this directory to $PATH and they will show up in hledger's commands list.
You can run them directly and they will install required dependencies and run in interpreted mode.
Or you can compile them to run faster (recommended) using `stack ghc` or the `bin/compile.sh` script.
201907: These scripts are tested infrequently and in need of update.
They are:
hledger-*.hs are example/experimental hledger add-on commands,
shipped as executable stack scripts:
- hledger-check.hs - check more complex account balance assertions
- hledger-smooth.hs - an attempt at automatically splitting infrequent/irregular transactions
- hledger-swap-dates.hs - swap all date and date2 fields
- hledger-swap-dates.hs - print transactions with their date and date2 fields swapped
You can run them directly and they will install required dependencies
and run in interpreted mode.
Or you can compile them to run faster using `stack ghc SCRIPT` or
`bin/compile.sh`.
Add this directory to $PATH and they will show up in hledger's commands list.
A reminder from http://hledger.org/hledger.html#add-on-commands :
when using the main hledger executable to run add-on commands, remember