106 lines
4.6 KiB
Plaintext
106 lines
4.6 KiB
Plaintext
hledger
|
|
==========================
|
|
|
|
hledger for techies
|
|
-------------------
|
|
|
|
hledger is a remix, in haskell_, of John Wiegley's excellent ledger_ accounting tool.
|
|
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://demo.hledger.org>`_.
|
|
|
|
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
|
|
---------------
|
|
``cabal install hledger``,
|
|
or try these `platform binaries`_,
|
|
or see the `installing docs <README.html#installing>`_.
|
|
|
|
Then see 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
|
|
- .. raw:: html
|
|
<form action="http://groups.google.com/group/hledger/boxsubscribe" >
|
|
join the <a href="http://hledger.org/list">mail list</a>. Your email:
|
|
<input type=text name=email><input type=submit name="sub" value="Subscribe">
|
|
</form>
|
|
- use the `issue tracker`_
|
|
- or `email me`_.
|
|
|
|
Related projects
|
|
----------------
|
|
- John Wiegley's ledger_ inspired hledger, and we try to stay compatible. You can often use both tools on the same ledger file.
|
|
- Uwe Hollerbach's umm_ is another haskell tool inspired by h/ledger.
|
|
- Tim Docker's ledger-reports_ uses hledger as a library to generate `html reports`_.
|
|
- I have a few older bits and pieces `here <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://demo.hledger.org/balance
|
|
.. _register: http://demo.hledger.org/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
|
|
.. _umm: http://www.korgwal.com/umm/
|
|
.. _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:
|