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

docs: final release docs

Browse Source
This commit is contained in:
Simon Michael 2012-05-29 18:34:33 +00:00
parent c23d1793ae
commit c8f6154de4
4 changed files with 47 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
ANNOUNCE
View File

@ -1,93 +1,52 @@
I'm pleased to announce version 0.16 of the hledger packages. This is a I'm pleased to announce version 0.18 of hledger.
stability/bugfix/polish release (which may become the pattern for
even-numbered releases in future.)
hledger is a library and set of user tools for working with financial hledger (http://hledger.org) is a haskell library, command-line tool and
data (or anything that can be tracked in a double-entry accounting web application for working with financial data (or anything that can be
ledger.) It is a haskell port and friendly fork of John Wiegley's tracked numerically in an accounting journal). It is inspired by and
Ledger. hledger provides command-line, curses and web interfaces, and compatible with John Wiegley's Ledger. hledger reads a plain text file
aims to be a reliable, practical tool for daily use. Given a plain describing transactions and lets you query account balances or transaction
text file describing transactions of money or any other commodity, it details by various criteria. It can also help you record new
will print the chart of accounts, account balances, or just the
transactions you're interested in. It can also help you record new
transactions, or convert CSV data from your bank. transactions, or convert CSV data from your bank.
Home: http://hledger.org Release notes (http://hledger.org/NEWS.html):
To install: cabal update, cabal install hledger. If you have trouble, let * web: hledger-web is now based on yesod 1.0
me know or watch the mail list/bug tracker for updates. Optional add-ons:
hledger-web hledger-vty hledger-chart hledger-interest.
Pre-built platform-specific binaries, which are time-consuming to make and * web: fix js error breaking second use of add form (#72)
support, are provided on request to anyone who donates. This is a great
way to give back and support the project! http://hledger.org/DOWNLOAD.html
Release notes for 0.16: * web: make `yesod devel` work
* cli: strip the -- when calling add-on commands, so their options work * the command-line now supports a more powerful query language, consistent with the web UI
(#64)
* cli: hledger ADDON --version now shows add-on command's version * hledger now fully supports tags (aka metadata) on both transactions and postings, and querying by tag or tag value
* cli: only the add and web commands auto-create the journal file * new commands `incomestatement`, `balancesheet`, and `cashflow` provide basic financial statements under certain conditions
* cli: give a non-confusing error if LEDGER_FILE contains a literal * format conversion is now done on demand, and the convert command has been dropped. So instead of
tilde `hledger convert FILE.csv` just do `hledger -f FILE.csv print` or any other command.
You can also pipe any supported format into `hledger -f- CMD` and hledger will try to do the right thing.
* add: clearer prompts, more validation, use . to end also * support for GHC 6.12 has been dropped; this release has been tested with GHC 7.0.4, 7.2.2, and 7.4.1
* add: use unix line endings consistently, avoiding parse error on * unicode is now handled properly on all supported GHC versions
windows (#51)
* add: avoid excess whitespace between transactions (#46) * API and internal cleanups
* balance: ledger compatibility fix: don't elide parent accounts with
multiple displayed subaccounts
* convert: always order converted transactions by date
* convert: rename currency -> base-currency, in-field, out-field ->
amount-in-field, amount-out-field
* convert: give an error, not a zero when date or
amount-in-field/amount-out-field parsing fails
* register: show more useful range of intervals with --empty and a query
pattern
* print, web: always show both dates, ignoring --effective (#42)
* web: production builds (the default with cabal) have all web content
embedded (dev builds use ./static/) (#63)
* web: update to yesod 0.9
* web: obey at least some of the general reporting options, like --cost
* web: adjust the default base url when a custom port is specified
* web: prevent an infinite redirect when custom base url has a trailing
slash
* web: fix "not:'multi word'" patterns
* web: hide old title and search form when adding/editing
* web: adjust --help to indicate command-line arguments are not expected
* web: don't bother running cli unit tests at startup
Stats: Stats:
- Release contributors: Simon Michael - Release contributors: Simon Michael, xiaoruoruo
- 30 days, 100 commits, 4 end-user features and 18 end-user bugfixes since - 87 days, 155 commits, 6 end-user features and 3 end-user bugfixes since
last major release last major release
- 219 unit & functional tests and 55% unit test coverage (hledger, - 216 unit & functional tests (hledger-lib & hledger)
hledger-lib packages)
- 7632 lines of code (all packages) - 7836 lines of code (hledger-lib, hledger & hledger-web)
Best, Install it:
-Simon
cabal update; cabal install hledger [hledger-web]
If you have trouble, see http://hledger.org/MANUAL.html#installing .
You can fund a ready-to-run binary for your platform with a donation at
http://hledger.org/DOWNLOAD.html .

17
MANUAL.md
View File

@ -4,7 +4,7 @@ title: hledger user manual
# User manual # User manual
Version: 0.18-unreleased Version: 0.18
## Introduction ## Introduction
@ -33,16 +33,16 @@ hledger works on linux, mac and windows. You can fund ready-to-run
binaries of the latest release - see the [download page](DOWNLOAD.html). binaries of the latest release - see the [download page](DOWNLOAD.html).
Otherwise, build the latest release from Hackage using cabal-install. Otherwise, build the latest release from Hackage using cabal-install.
Ensure you have [GHC](http://hackage.haskell.org/ghc/) (6.12.3 or greater; Ensure you have [GHC](http://hackage.haskell.org/ghc/) 7.0 or greater or
7.0 or greater for hledger-web) or the the [Haskell Platform](http://hackage.haskell.org/platform/) installed,
[Haskell Platform](http://hackage.haskell.org/platform/) installed, then: then:
$ cabal update $ cabal update
$ cabal install hledger $ cabal install hledger
To also install the web interface, do: To also install the web interface, do:
$ cabal install hledger-web $ cabal install hledger hledger-web
To build the latest [development version](DEVELOPMENT.html) do: To build the latest [development version](DEVELOPMENT.html) do:
@ -1259,13 +1259,12 @@ or get help.
If not, `cabal update` and try again. If not, `cabal update` and try again.
- **Do you have a new enough version of GHC ?** - **Do you have a new enough version of GHC ?**
Run `ghc --version`. hledger requires GHC 6.12.3 or greater Run `ghc --version`. hledger requires GHC 7.0 or greater
(on [some platforms](#5551), 7.2.1 can be helpful) and hledger-web (on [some platforms](#5551), 7.2.1 can be helpful).
requires 7.0 or greater.
- **Do you have a new enough version of cabal ?** - **Do you have a new enough version of cabal ?**
Avoid ancient versions. `cabal --version` should report at least Avoid ancient versions. `cabal --version` should report at least
0.10. You may be able to upgrade it with: 0.10 (and 0.14 is much better). You may be able to upgrade it with:
$ cabal update $ cabal update
$ cabal install cabal-install $ cabal install cabal-install

19
NEWS.md
View File

@ -4,24 +4,19 @@ title: hledger news
# News # News
## (unreleased) hledger-web 0.18 ## 2012/5/29 hledger 0.18
* web: fix js error breaking second use of add form (#72) * web: hledger-web is now based on yesod 1.0
* web: fix js error breaking second use of add form ([#72](http://code.google.com/p/hledger/issues/detail?id=72))
* web: make `yesod devel` work * web: make `yesod devel` work
* web: officially drop GHC 6.12 support, fix build warnings with 7.0, 7.2, 7.4 * the command-line now supports a more powerful [query language](MANUAL.html#queries), consistent with the web UI
* web: hledger-web is now based on yesod 0.10 * hledger now fully supports [tags](MANUAL.html#tags) (aka metadata) on both transactions and postings, and querying by tag or tag value
## 2012/5/28 hledger 0.18
* the command-line now supports a more powerful query language, consistent with the web UI
* hledger now fully supports tags (aka metadata) on both transactions and postings, and querying by tag or tag value
* new commands `incomestatement`, `balancesheet`, and `cashflow` provide basic financial statements under certain [conditions](http://hledger.org/MANUAL.html#incomestatement) * new commands `incomestatement`, `balancesheet`, and `cashflow` provide basic financial statements under certain [conditions](http://hledger.org/MANUAL.html#incomestatement)
* support for GHC 6.12 has been dropped; this release has been tested with GHC 7.0.4, 7.2.2, and 7.4.1
* unicode is now handled properly on all supported GHC versions
* format conversion is now done on demand, and the convert command has been dropped. So instead of * format conversion is now done on demand, and the convert command has been dropped. So instead of
`hledger convert FILE.csv` just do `hledger -f FILE.csv print` or any other command. `hledger convert FILE.csv` just do `hledger -f FILE.csv print` or any other command.
You can also pipe any supported format into `hledger -f- CMD` and hledger will try to do the right thing. You can also pipe any supported format into `hledger -f- CMD` and hledger will try to do the right thing.
* fix build warnings in all GHC versions * support for GHC 6.12 has been dropped; this release has been tested with GHC 7.0.4, 7.2.2, and 7.4.1
* unicode is now handled properly on all supported GHC versions
* API and internal cleanups * API and internal cleanups
## 2012/3/3 hledger-web 0.17.1 ## 2012/3/3 hledger-web 0.17.1

6
README.md
View File

@ -25,10 +25,6 @@ learn more, including
[how we are different from ledger](FAQ.html#how-does-hledger-relate-to-ledger), [how we are different from ledger](FAQ.html#how-does-hledger-relate-to-ledger),
and get started tracking your numbers! and get started tracking your numbers!
<a href="https://www.wepay.com/donate/74643?ref=widget&utm_medium=widget&utm_campaign=donation"
target="_blank" style="float:right; margin:0 1em;"
><img src="https://www.wepay.com/img/widgets/donate_with_wepay.png" alt="Donate with WePay" /></a>
For support and more technical info, see the [contributor guide](DEVELOPMENT.html) For support and more technical info, see the [contributor guide](DEVELOPMENT.html)
or [email me](mailto:simon@joyful.com?subject=hledger:). I appreciate or [email me](mailto:simon@joyful.com?subject=hledger:). I appreciate
feedback and help with all aspects of hledger. Please give it a try and feedback and help with all aspects of hledger.
let me know how we're doing. Best -Simon