hledger
==========================

*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 <http://joyful.com/repos/hledger/sample.ledger>`_ or `timelog <http://joyful.com/repos/hledger/sample.timelog>`_ describing your transactions and displays
precise reports via 
`command-line <SCREENSHOTS.html#hledger-screen-1>`_, 
`curses <SCREENSHOTS.html#sshot>`_ or 
`web interface <http://hledger.org:5000>`_.
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
- 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.

Getting started
---------------
hledger works on all major platforms.
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 <SCREENSHOTS.html>`_, and perhaps c++ ledger's `home page`_ and manual_.

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`_.

.. raw:: html
 <a name="contact" />

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
- use the `issue tracker`_
- .. raw:: html
     <form action="http://groups.google.com/group/hledger/boxsubscribe">
       join the <a href="http://hledger.org/list">mail list</a>. Email:
       <input type=text name=email><input type=submit name="sub" value="Subscribe">
     </form>

- for something private, `email me`_.

Related projects
----------------
- 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 .

.. raw:: html

 <a href="https://www.google.com/analytics/reporting/?reset=1&id=15489822" accesskey="a"></a>


.. -------------------------------------------------------------------------

.. _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
.. _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
.. _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 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 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
.. _manual:               http://joyful.com/repos/ledger/doc/ledger.html
.. _ledger-reports:       http://dockerz.net/repos/ledger-reports
.. _html reports:         http://dockerz.net/software/hledger_report_sample/report.html

.. .. raw:: html

 <a href="http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=shortlog"><img src=http://joyful.com/repos/hledger/commits.png border=0></a>

.. rst quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html

.. Local variables:
.. mode: rst
.. End: