diff --git a/HOME b/HOME index af6baa85e..8e125646f 100644 --- a/HOME +++ b/HOME @@ -1,69 +1,56 @@ hledger -======= -***double-entry accounting.. just the numbers*** +========================== -Welcome! hledger is a software tool for double-entry accounting. +*just the numbers* +------------------ + +Welcome! hledger is software for doing double-entry accounting with less pain and more gain. It reads a plain text -`ledger file`_ or `timelog`_ describing your transactions and displays +`ledger file `_ or `timelog `_ describing your transactions and displays precise reports via `command-line `_, `curses `_ or -`web interface `_. +`web interface `_. +I use it every day to: track spending and income; see time reports by day/week/month/project; get accurate numbers for client billing and tax returns; find unpaid invoices, and so on. +hledger is a remix, in haskell_, of John Wiegley's excellent ledger_. hledger aims to be: -- a practical, accessible, dependable tool for end users. I use it every day to track money and time. -- a useful library for finance-minded haskell programmers +- a practical, accessible, dependable tool for end users +- a useful library and toolbox for finance-minded haskell programmers - a successful, time-and-money-solvent project within a thriving ecosystem of financial software projects. -hledger is free software by Simon Michael & co., released under GNU GPLv3. -It is a remix, in haskell_, of John Wiegley's excellent c++ ledger_. - - -.. raw:: html - - -.. comment - - .. raw:: html - - - - +hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. Getting started --------------- hledger works on all major platforms. -One of these `experimental binaries`_ might work for you. -Otherwise: install the `Haskell Platform`_, then ``cabal install hledger``. -See also the `User's Guide`_ | News_ | `Screenshots `_ as well as c++ ledger's `home page`_ and manual_. +One of these `platform binaries`_ might work for you. +Otherwise: install the `Haskell Platform`_, then type ``cabal install hledger``. +See also hledger's `User's Guide`_, News_, `Screenshots `_, and perhaps c++ ledger's `home page`_ and manual_. -If you're a developer, you can get the latest code with ``darcs get http://joyful.com/repos/hledger`` or `browse with darcsweb`_. -See also the `Developer API docs`_ | `Developer Notes`_ | `Contributor List`_ | -hackage_ page | latest benchmark_, profile_, heap_, `test coverage`_ reports. +If you're a developer, `browse the code`_ or ``darcs get http://joyful.com/repos/hledger``. +See also the `hackage page`_, `Developer API docs`_, and latest notes_, benchmark_, profile_, heap_, `test coverage`_. -.. include:: NEWS +.. raw:: html + -Getting help -------------- -To get help or share tips, use one of the channels below. -Reports and/or patches for website issues, unclear/stale/missing -docs, or any difficulty encountered while installing, using, or -contributing to hledger are appreciated! +To get help or discuss, use one of the channels below. +Reports/patches for any issues with hledger, documentation, or website are appreciated! - chat Simon (sm) on the `#ledger irc channel`_ which we share with ledger -- join the `hledger google group`_ - use the `issue tracker`_ +- .. raw:: html +
+ join the mail list. Email: + +
+ - for something private, `email me`_. -.. comment - .. raw:: html - - - Related projects ---------------- -- John Wiegley's ledger_ inspired hledger, and the two projects are coevolving. If you like hledger, try ledger too. +- John Wiegley's ledger_ inspired hledger, and the two projects are coevolving. If you like hledger, try ledger too. You can run both on the same ledger file if you stick with the core features. - Tim Docker's ledger-reports_ uses hledger as a library to generate `html reports`_. - I have a few older bits and pieces at http://joyful.com/Ledger . @@ -72,30 +59,33 @@ Related projects -.. _`ledger file`: http://joyful.com/repos/hledger/sample.ledger +.. ------------------------------------------------------------------------- + +.. _ledger file: http://joyful.com/repos/hledger/sample.ledger .. _timelog: http://joyful.com/repos/hledger/sample.timelog .. _balance: http://hledger.org:5000/balance .. _register: http://hledger.org:5000/register?a=checking&p=weekly -.. _hledger google group: http://groups.google.com/group/hledger -.. _issue tracker: http://code.google.com/p/hledger/issues/list?can=1&q=&colspec=ID+Type+Status+Priority+Milestone+Owner+Summary&x=status&y=type&mode=grid&cells=tiles -.. _experimental binaries: http://hledger.org/binaries/ +.. _mail list: http://list.hledger.org +.. _issue tracker: http://bugs.hledger.org +.. _platform binaries: http://hledger.org/binaries/ .. _User's Guide: README.html .. _News: NEWS.html .. _Contributor List: CONTRIBUTORS.html .. _Developer API docs: http://hledger.org/api-doc -.. _Developer Notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES +.. _notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES .. _benchmark: http://hledger.org/profs/latest.bench .. _profile: http://hledger.org/profs/latest.prof .. _heap: http://hledger.org/profs/latest.ps .. _test coverage: http://hledger.org/profs/coverage/hpc_index_fun.html -.. _browse with darcsweb: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger +.. _browse the code: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger .. _email me: mailto:simon@joyful.com .. _Simon Michael: http://joyful.com +.. _co.: http://hledger.org/CONTRIBUTORS.html .. _haskell: http://haskell.org .. _GHC: http://haskell.org/ghc .. _cabal: http://haskell.org/cabal/download.html .. _Haskell Platform: http://hackage.haskell.org/platform/ -.. _hackage: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger +.. _hackage page: http://hackage.haskell.org/package/hledger .. _#ledger irc channel: irc://irc.freenode.net/#ledger .. _ledger: http://wiki.github.com/jwiegley/ledger .. _home page: http://wiki.github.com/jwiegley/ledger @@ -103,6 +93,9 @@ Related projects .. _ledger-reports: http://dockerz.net/repos/ledger-reports .. _html reports: http://dockerz.net/software/hledger_report_sample/report.html +.. .. raw:: html + + .. rst quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html