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

update installation docs, emphasising cabal

Browse Source
This commit is contained in:
Simon Michael 2009-04-02 02:09:40 +00:00
parent 7ba0dc06a5
commit 3ff6c41ba6
1 changed files with 26 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README
View File

@ -3,10 +3,13 @@ hledger - a ledger-compatible text-based accounting tool
Welcome to hledger! Welcome to hledger!
hledger is a haskell clone of John Wiegley's "ledger" text-based hledger is a partial haskell clone of John Wiegley's text-based accounting
accounting tool (http://newartisans.com/software/ledger.html). tool, "ledger" (http://newartisans.com/software/ledger.html).
It generates ledger-compatible register & balance reports from a plain
text ledger file, and demonstrates a functional implementation of ledger. hledger generates ledger-compatible register & balance reports from a
plain text journal, and demonstrates a functional implementation of
ledger.
For more information, see hledger's home page: http://joyful.com/hledger For more information, see hledger's home page: http://joyful.com/hledger
Copyright (c) 2007-2009 Simon Michael <simon@joyful.com> Copyright (c) 2007-2009 Simon Michael <simon@joyful.com>
@ -15,35 +18,32 @@ Released under GPL version 3 or later.
Installation Installation
------------ ------------
hledger requires GHC. It is known to build with 6.8 and 6.10. Building hledger requires GHC (http://haskell.org/ghc); it is known to
If you have cabal-install, do:: build with GHC 6.8 and up. hledger should work on any platform which GHC
supports.
Also, installing hledger easily requires the "cabal" command-line tool,
version 0.6.0 and up (http://www.haskell.org/cabal/download.html). (You
can also manually download and install each dependency mentioned in
hledger.cabal from hackage.org, but installing cabal is much quicker.)
Here's how to download and install the latest hledger release::
cabal update cabal update
cabal install hledger cabal install hledger
Otherwise, unpack the latest tarball from Or, to build with all optional features enabled (downloads additional
http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger and do:: dependencies)::
runhaskell Setup.hs configure cabal install --flags="happs vty" hledger
runhaskell Setup.hs build
sudo runhaskell Setup.hs install
This will complain about any missing libraries, which you can download and The available flags are::
install manually from hackage.haskell.org. The Build-Depends: in
hledger.cabal has the full package list.
You can configure with optional flags to build additional hledger happs - enable the built-in webserver
features. These are:: vty - enable the curses text ui
ansi - enable the ansi text ui (use instead of vty on MS windows)
-f vty - Build vty-based text ui (requires vty, not available on windows) And for developers, here's how to get the latest development code::
-f ansi - Build ansi-based text ui (requires ansi-terminal)
-f happs - Build happs-based web ui (requires HApps-Server)
Eg::
cabal install -f "vty ansi happs" hledger (or runhaskell Setup.hs configure -f "vty ansi happs")
To get the latest development code do::
darcs get http://joyful.com/repos/hledger darcs get http://joyful.com/repos/hledger
@ -52,8 +52,7 @@ Usage
----- -----
hledger looks for your ledger file at ~/.ledger by default. To use a hledger looks for your ledger file at ~/.ledger by default. To use a
different file, specify it with the LEDGER environment variable or -f different file, specify it with the LEDGER environment variable or -f
option (which may be - for standard input). Here are some commands to option (which may be - for standard input). Here are some commands to try::
try::
hledger --help hledger --help
hledger -f sample.ledger balance hledger -f sample.ledger balance