mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 18:29:36 +03:00
doc: release notes, announcement, download page
This commit is contained in:
Simon Michael
parent
effb679569
commit
a95a64db0d
120
doc/ANNOUNCE
120
doc/ANNOUNCE
@ -1,78 +1,87 @@
|
||||
Aloha! I'm pleased to announce hledger 1.4.
|
||||
I'm very pleased to announce hledger 1.5.
|
||||
A big thank you to the release contributors:
|
||||
Dmitry Astapov,
|
||||
Mykola Orliuk,
|
||||
Eli Flanagan,
|
||||
Elijah Caine,
|
||||
Sam Jeeves,
|
||||
Matthias Kauer,
|
||||
Hans-Peter Deifel,
|
||||
Mick Dekkers,
|
||||
Nadrieril,
|
||||
Alvaro Fernando García.
|
||||
|
||||
Thank you release contributors: Nicholas Niro, Hans-Peter Deifel,
|
||||
Jakub Zárybnický, Felix Yan, Mark Hansen, Christian G. Warden,
|
||||
Nissar Chababy and Peter Simons.
|
||||
|
||||
Also, if I haven't already mentioned it: this year hledger turns 10!
|
||||
Here's the first commit, from January 27 2007:
|
||||
https://github.com/simonmichael/hledger/commit/85864b41
|
||||
We have come a way, but there is much yet to look forward to.
|
||||
Onward and upward!
|
||||
|
||||
The next major release is scheduled for 2017/12/31.
|
||||
The next major release is scheduled for 2018/03/31.
|
||||
|
||||
What is hledger ?
|
||||
-----------------
|
||||
|
||||
hledger (http://hledger.org) is an evolving, dependable, robust,
|
||||
cross-platform program for tracking money, time, or any other
|
||||
commodity, using double-entry accounting and a simple plain text file
|
||||
format. It is a haskell reimplementation of Ledger and the plain text
|
||||
accounting concept, providing command-line, curses and web
|
||||
interfaces. hledger aims to be a pleasant and practical tool for
|
||||
personal, business or institutional finance and time tracking.
|
||||
hledger (http://hledger.org) is an evolving, reliable, cross-platform
|
||||
program for tracking money, time, or any other commodity, using
|
||||
double-entry accounting and a simple plain text file format. It is a
|
||||
haskell reimplementation of Ledger and the plain text accounting
|
||||
concept, providing command-line, curses and web interfaces. hledger
|
||||
aims to be a pleasant and practical tool for personal, business or
|
||||
institutional finance and time tracking.
|
||||
|
||||
What's new ?
|
||||
------------
|
||||
|
||||
The full release notes are at http://hledger.org/release-notes#hledger-1.4 .
|
||||
The full release notes are at http://hledger.org/release-notes#hledger-1.5 .
|
||||
Some highlights:
|
||||
|
||||
- Easy install script: we have a new installation method for the
|
||||
hledger tools, intended to dodge common pitfalls and just-work more
|
||||
often. Building on the stack team's install script, this bash script
|
||||
is cross platform, uses cabal or stack, installs stack and GHC if
|
||||
needed, and installs the latest release of all major hledger
|
||||
packages. See http://hledger.org/download for details.
|
||||
* Ledger-style automated posting rules to modify transactions, enabled
|
||||
with --auto flag
|
||||
|
||||
- More batteries included: most experimental addon commands formerly
|
||||
shipped in bin/ are now built in and work out of the box.
|
||||
* Ledger-style periodic transaction rules to generate forecast
|
||||
transactions (--forecast) and budget goals
|
||||
|
||||
- New commands:
|
||||
balancesheetequity (a balance sheet including equity),
|
||||
tags (list tags in use),
|
||||
import (detects new transactions in multiple input files and adds them
|
||||
to the main journal, particularly useful with CSV downloads).
|
||||
* a new budget report (balance --budget) comparing amounts with
|
||||
per-period and per-account budget goals
|
||||
|
||||
- Balance reports can be sorted by amount - makes those high expenses
|
||||
easy to spot.
|
||||
* more expressive period expressions
|
||||
|
||||
- CLI conveniences:
|
||||
@ARGSFILE is expanded to the set of args/flags in ARGSFILE.
|
||||
depth:2 or --depth=2 can be written as -2.
|
||||
* space can be used as digit group separator character in numbers
|
||||
|
||||
* commodity or default commodity directives give more control over
|
||||
display precision and decimal point/digit group separator
|
||||
|
||||
- Help improvements: reorganized docs page, a more useful commands
|
||||
list, a smarter help command, --help and -h are the same again (by
|
||||
popular demand),
|
||||
|
||||
Getting started
|
||||
---------------
|
||||
|
||||
See http://hledger.org/download for all install methods.
|
||||
Windows users can download nightly binaries.
|
||||
On other platforms, you may need to build the latest release yourself.
|
||||
The easiest and most reliable way is to run the hledger install script.
|
||||
This requires only bash and will install the hledger tools in $HOME/.local/bin/.
|
||||
(It uses an installed cabal or stack if possible, otherwise installs
|
||||
stack and GHC in $HOME/.local/bin and $HOME/.stack/).
|
||||
Here's the responsible way to run it:
|
||||
|
||||
To get the latest hledger release, you may need to build it yourself
|
||||
using stack or cabal. But don't worry, this is.. getting quite painless.
|
||||
The new hledger installer requires only bash and will install
|
||||
everything you need in one step: the hledger tools in
|
||||
$HOME/.local/bin/, and (if required) stack and GHC in $HOME/.stack/.
|
||||
Run it like so:
|
||||
$ curl -O https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh
|
||||
$ less hledger-install.sh # (do security review)
|
||||
$ bash hledger-install.sh # (add -v for more detail; use bash -x to show commands being run)
|
||||
|
||||
$ curl -sSLO http://hledger.org/hledger-install.sh
|
||||
$ less hledger-install.sh # review script, for the security conscious
|
||||
$ bash hledger-install.sh # install the latest hledger tools
|
||||
or the more convenient, less secure way:
|
||||
|
||||
Ensure $HOME/.local/bin is in your $PATH. Now try some commands:
|
||||
$ curl https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh | bash
|
||||
|
||||
or, to install individual tools:
|
||||
|
||||
$ stack install hledger-1.5 # hledger-ui-1.5 hledger-web-1.5 hledger-api-1.5 etc.
|
||||
|
||||
or:
|
||||
|
||||
$ cabal update
|
||||
$ cabal install hledger-1.5 # hledger-ui-1.5 hledger-web-1.5 hledger-api-1.5 etc.
|
||||
|
||||
Note: building haskell apps can take significant time, memory, and disk space, especially the first time.
|
||||
You can kill and restart the installer without losing progress.
|
||||
If it fails, please help us improve it by reporting the full output.
|
||||
|
||||
After installation, ensure $HOME/.local/bin is in your $PATH.
|
||||
Now try some commands:
|
||||
|
||||
$ hledger -h # quick help
|
||||
$ hledger help # list built-in manuals
|
||||
@ -87,10 +96,9 @@ and http://plaintextaccounting.org
|
||||
Or say hello and ask questions in the #hledger IRC channel on Freenode:
|
||||
http://irc.hledger.org
|
||||
|
||||
If you have been finding hledger useful, I invite you to become a
|
||||
sponsor or contributor to make it stronger. Donate using one of the
|
||||
funding links on the home page, give feedback, report bugs, send
|
||||
pull requests, write about it, or help in some other way.
|
||||
Thanks for your support! I hope to meet you online.
|
||||
If you have been finding hledger useful, I invite you to become a
|
||||
sponsor or donor to make it stronger (see home page).
|
||||
Also give feedback, report bugs, send pull requests, write about it,
|
||||
etc. Thanks for your help!
|
||||
|
||||
-Simon
|
||||
|
||||
@ -69,9 +69,10 @@ Or, you can install manually (all systems):
|
||||
Eg if you're a bash user:\
|
||||
`echo "export PATH=$PATH:~/.local/bin" >> ~/.bashrc && source ~/.bashrc`
|
||||
|
||||
2. **`stack install --install-ghc --resolver lts-9 hledger-lib-1.4 hledger-1.4 [hledger-ui-1.4] [hledger-web-1.4] [hledger-api-1.4]`**\
|
||||
2. **`stack install --resolver nightly hledger-lib-1.5 hledger-1.5 [hledger-ui-1.5] [hledger-web-1.5] [hledger-api-1.5]`**\
|
||||
\
|
||||
This command installs the specified hledger packages (and required haskell libraries and tools) from [Stackage](https://www.stackage.org) (and if needed, [Hackage](http://hackage.haskell.org)).
|
||||
It will work once the release has landed in stackage nightly, usually 1-2 days after hledger release.
|
||||
As noted above, it can take a while.
|
||||
You can add `--dry-run` to see what it plans to do, and kill/restart it without losing progress.\
|
||||
You can omit the bracketed packages to save time, and maybe install them later. If you include them, don't type the brackets.
|
||||
|
||||
@ -7,6 +7,7 @@ h4 { margin-top:2em; }
|
||||
<nav id="toc">
|
||||
<p>Major releases:</p>
|
||||
<ol>
|
||||
<li><a href="#hledger-1.5">hledger 1.5 (2017/12/31)</a>
|
||||
<li><a href="#hledger-1.4">hledger 1.4 (2017/9/30)</a>
|
||||
<li><a href="#hledger-1.3">hledger 1.3 (2017/6/30)</a>
|
||||
<li><a href="#hledger-1.2">hledger 1.2 (2017/3/31)</a>
|
||||
@ -45,6 +46,124 @@ h4 { margin-top:2em; }
|
||||
# Release notes
|
||||
|
||||
|
||||
## 2017/12/31 hledger 1.5
|
||||
|
||||
***
|
||||
***
|
||||
|
||||
<!-- ([announcement](https://groups.google.com/forum/#!topic/hledger/)) -->
|
||||
|
||||
Release contributors:
|
||||
Dmitry Astapov,
|
||||
Mykola Orliuk,
|
||||
Eli Flanagan,
|
||||
Elijah Caine,
|
||||
Sam Jeeves,
|
||||
Matthias Kauer,
|
||||
Hans-Peter Deifel,
|
||||
Mick Dekkers,
|
||||
Nadrieril,
|
||||
Alvaro Fernando García.
|
||||
|
||||
[project](#project-wide-changes-for-1.5)
|
||||
| [hledger-install](#hledger-install.sh-1.5)
|
||||
| [hledger-lib](#hledger-lib-1.5)
|
||||
| [hledger](#hledger-1.5-1)
|
||||
| [hledger-ui](#hledger-ui-1.5)
|
||||
| [hledger-web](#hledger-web-1.5)
|
||||
| [hledger-api](#hledger-api-1.5)
|
||||
|
||||
### project-wide changes for 1.5
|
||||
|
||||
* remove upper bounds on all but hledger* and base (experimental)
|
||||
It's rare that my deps break their api or that newer versions must
|
||||
be avoided, and very common that they release new versions which I
|
||||
must tediously and promptly test and release hackage revisions for
|
||||
or risk falling out of stackage. Trying it this way for a bit.
|
||||
|
||||
### hledger-install.sh 1.5
|
||||
|
||||
### hledger-lib 1.5
|
||||
|
||||
* -V/--value uses today's market prices by default, not those of last transaction date. #683, #648)
|
||||
|
||||
* csv: allow balance assignment (balance assertion only, no amount) in csv records (Nadrieril)
|
||||
|
||||
* journal: allow space as digit group separator character, #330 (Mykola Orliuk)
|
||||
|
||||
* journal: balance assertion errors now show line of failed assertion posting, #481 (Sam Jeeves)
|
||||
|
||||
* journal: better errors for directives, #402 (Mykola Orliuk)
|
||||
|
||||
* journal: better errors for included files, #660 (Mykola Orliuk)
|
||||
|
||||
* journal: commodity directives in parent files are inherited by included files, #487 (Mykola Orliuk)
|
||||
|
||||
* journal: commodity directives limits precision even after -B, #509 (Mykola Orliuk)
|
||||
|
||||
* journal: decimal point/digit group separator chars are now inferred from an applicable commodity directive or default commodity directive. #399, #487 (Mykola Orliuk)
|
||||
|
||||
* journal: numbers are parsed more strictly (Mykola Orliuk)
|
||||
|
||||
* journal: support Ledger-style automated postings, enabled with --auto flag (Dmitry Astapov)
|
||||
|
||||
* journal: support Ledger-style periodic transactions, enabled with --forecast flag (Dmitry Astapov)
|
||||
|
||||
* period expressions: fix "nth day of {week,month}", which could generate wrong intervals (Dmitry Astapov)
|
||||
|
||||
* period expressions: month names are now case-insensitive (Dmitry Astapov)
|
||||
|
||||
* period expressions: stricter checking for invalid expressions (Mykola Orliuk)
|
||||
|
||||
* period expressions: support "every 11th Nov" (Dmitry Astapov)
|
||||
|
||||
* period expressions: support "every 2nd Thursday of month" (Dmitry Astapov)
|
||||
|
||||
* period expressions: support "every Tuesday", short for "every <n>th day of week" (Dmitry Astapov)
|
||||
|
||||
### hledger 1.5
|
||||
|
||||
* --auto adds Ledger-style automated postings to transactions (Dmitry Astapov, Mykola Orliuk)
|
||||
|
||||
* --forecast generates Ledger-style periodic transactions in the future (Dmitry Astapov, Mykola Orliuk)
|
||||
|
||||
* -V/--value uses today's market prices by default, not those of last transaction date. #683, #648
|
||||
|
||||
* add: suggest implied (parent) and declared (by account directives) account names also
|
||||
|
||||
* bal: --budget shows performance compared to budget goals defined
|
||||
with periodic transactions. Accounts with budget goals are
|
||||
displayed folded (depth-clipped) at a depth matching the budget
|
||||
specification. Unbudgeted accounts are hidden, or with
|
||||
--show-unbudgeted, shown at their usual depth. (Dmitry Astapov)
|
||||
|
||||
* import: the output of --dry-run is now valid journal format
|
||||
|
||||
* print: -B shows converted amounts again, as in 1.1, even without
|
||||
-x. #551 (Mykola Orliuk, Simon Michael)
|
||||
|
||||
* tag: the first argument now filters tag names, additional arguments
|
||||
filter transactions (#261)
|
||||
|
||||
### hledger-ui 1.5
|
||||
|
||||
* fix help -> view manual (on posix platforms) #623
|
||||
|
||||
* support -V/--value, --forecast, --auto
|
||||
|
||||
### hledger-web 1.5
|
||||
|
||||
* add form account fields now suggest implied and declared account names also
|
||||
|
||||
* add form date field now uses a datepicker (Eli Flanagan)
|
||||
|
||||
* don't write a session file at startup, don't require a writable working directory
|
||||
|
||||
* support -V/--value, --forecast, --auto
|
||||
|
||||
### hledger-api 1.5
|
||||
|
||||
|
||||
## 2017/9/30 hledger 1.4
|
||||
|
||||
***easy install script,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user