From b4bdc926dd82e451f8f188dbfc505664d28b02ef Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 17 Jan 2009 21:03:34 +0000 Subject: [PATCH] readme updates --- README | 25 ++++++++++++++----------- hledger.cabal | 8 ++++---- hledger.hs | 12 ++++++------ 3 files changed, 24 insertions(+), 21 deletions(-) diff --git a/README b/README index d9970f17a..220336eb2 100644 --- a/README +++ b/README @@ -3,28 +3,28 @@ hledger - a ledger-compatible text-based accounting tool Welcome to hledger! -hledger is a minimal haskell clone of John Wiegley's "ledger" text-based -accounting tool (http://newartisans.com/software/ledger.html). hledger -generates ledger-compatible register & balance reports from a plain text -ledger file, and demonstrates a functional implementation of ledger. For -more information, see the hledger home page: http://joyful.com/hledger +hledger is a haskell clone of John Wiegley's "ledger" text-based +accounting tool (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. +For more information, see hledger's home page: http://joyful.com/hledger -Copyright (c) 2007-2008 Simon Michael +Copyright (c) 2007-2009 Simon Michael Released under GPL version 3 or later. Installation ------------ -hledger requires GHC. It is known to build with 6.8. +hledger requires GHC. It is known to build with 6.8 and 6.10. -With cabal-install -.................. +Installing with cabal +..................... If you have cabal-install, in this directory do:: cabal install -Manually -........ +Installing manually +................... Otherwise, unpack the latest tarball from http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger and do:: @@ -56,6 +56,9 @@ Here are some commands to try:: hledger reg -- shop hledger ui +hledger looks for your ledger file at ~/.ledger by default. To use a different file, +specify it with -f or the LEDGER environment variable. + Features -------- diff --git a/hledger.cabal b/hledger.cabal index b8f1efb5d..2f2ae7191 100644 --- a/hledger.cabal +++ b/hledger.cabal @@ -2,10 +2,10 @@ Name: hledger Version: 0.2 Category: Finance Synopsis: A ledger-compatible text-based accounting tool. -Description: hledger is a minimal haskell clone of John Wiegley's "ledger" text-based - accounting tool (http://newartisans.com/software/ledger.html). hledger - generates ledger-compatible register & balance reports from a plain text - ledger file, and demonstrates a functional implementation of ledger. +Description: hledger is a haskell clone of John Wiegley's "ledger" text-based + accounting tool (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. License: GPL Stability: alpha Author: Simon Michael diff --git a/hledger.hs b/hledger.hs index 85fce23cc..b60586631 100644 --- a/hledger.hs +++ b/hledger.hs @@ -2,14 +2,14 @@ {-| hledger - a ledger-compatible text-based accounting tool. -Copyright (c) 2007-2008 Simon Michael +Copyright (c) 2007-2009 Simon Michael Released under GPL version 3 or later. -hledger is a minimal haskell clone of John Wiegley's "ledger" text-based -accounting tool (http://newartisans.com/software/ledger.html). hledger -generates ledger-compatible register & balance reports from a plain text -ledger file, and demonstrates a functional implementation of ledger. For -more information, see the hledger home page: http://joyful.com/hledger +hledger is a haskell clone of John Wiegley's "ledger" text-based +accounting tool (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. +For more information, see hledger's home page: http://joyful.com/hledger You can use the command line: