say more about requirements

This commit is contained in:
Simon Michael 2008-12-10 09:45:00 +00:00
parent b8f8dad7d6
commit b1f4bd8ec3

30
README
View File

@ -15,18 +15,32 @@ Released under GPL version 3 or later.
Installation Installation
------------ ------------
hledger requires GHC. It is known to build with 6.8.
With cabal-install
..................
If you have cabal-install, in this directory do:: If you have cabal-install, in this directory do::
cabal install cabal install
otherwise, unpack the latest tarball from Manually
........
Otherwise, unpack the latest tarball from
http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger and do:: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger and do::
runhaskell Setup.hs configure runhaskell Setup.hs configure
runhaskell Setup.hs build runhaskell Setup.hs build
sudo runhaskell Setup.hs install sudo runhaskell Setup.hs install
or for the latest development code: darcs get http://joyful.com/repos/hledger This will complain about any missing libraries, which you can download and
install manually from hackage.haskell.org. (The Build-Depends: in
hledger.cabal has the full package list.)
Latest development code
.......................
Or, to get the latest development code do::
darcs get http://joyful.com/repos/hledger
Examples Examples
@ -40,15 +54,17 @@ Here are some commands to try::
hledger register hledger register
hledger reg cash hledger reg cash
hledger reg -- shop hledger reg -- shop
hledger ui
Features Features
-------- --------
This version of hledger mimics a subset of ledger 2.6.1. We currently This version of hledger mimics a subset of ledger 2.6.1, and adds some
support: the balance, print, and register commands, regular ledger features of its own. We currently support: the balance, print, and
entries, multiple commodities, virtual transactions, account and register commands, regular ledger entries, multiple commodities, virtual
description patterns, the LEDGER environment variable, and these options:: transactions, account and description patterns, the LEDGER environment
variable, and these options::
Basic options: Basic options:
-h, --help display summarized help text -h, --help display summarized help text
@ -80,6 +96,7 @@ We handle (almost) the full period expression syntax, and simple display
expressions consisting of a date predicate. Also the following expressions consisting of a date predicate. Also the following
hledger-specific features are supported:: hledger-specific features are supported::
ui interactive text ui
--depth=N balance report: maximum account depth to show --depth=N balance report: maximum account depth to show
--options-anywhere allow options anywhere, use ^ for negative patterns --options-anywhere allow options anywhere, use ^ for negative patterns
@ -158,7 +175,6 @@ Other differences
* hledger keeps differently-priced amounts of the same commodity separate at the moment * hledger keeps differently-priced amounts of the same commodity separate at the moment
* hledger refers to the entry's and transaction's "description", ledger calls it "note" * hledger refers to the entry's and transaction's "description", ledger calls it "note"
* hledger doesn't require a space before command-line option values * hledger doesn't require a space before command-line option values
* hledger doesn't parse all ledger file constructs (and may choke ? please report)
* hledger provides "--cost" as a synonym for "--basis" * hledger provides "--cost" as a synonym for "--basis"
* hledger's "weekly" reporting intervals always start on mondays * hledger's "weekly" reporting intervals always start on mondays
* hledger shows start and end dates of full intervals, not just the span containing data * hledger shows start and end dates of full intervals, not just the span containing data