From 66a8bac53a42e7b0447139ca47c5f53a3914e150 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 2 Jun 2009 21:44:34 +0000 Subject: [PATCH] clean up homepage rst markup --- HOME | 93 +++++++++++++++++++++++++++++++++++------------------------- 1 file changed, 55 insertions(+), 38 deletions(-) diff --git a/HOME b/HOME index c7faa1dee..5e657e3a9 100644 --- a/HOME +++ b/HOME @@ -3,16 +3,12 @@ hledger **Welcome! hledger is...** -- a Free Software project developed since 2007 by - `Simon Michael `_ and contributors. -- a command-line (or curses or web-based) double-entry accounting tool. It reads a - `plain text ledger `_ - describing your transactions and displays precise - `balance `_ and - `register `_ reports. -- a remix, in `haskell `_, of John Wiegley's excellent - c++ `ledger `_. hledger reads most standard ledger files - and vice-versa. +- a Free Software project developed since 2007 by `Simon Michael`_ and contributors. +- a command-line (or curses or web-based) double-entry accounting tool. + It reads a plain text `ledger file`_ describing your transactions and + displays precise balance_ and register_ reports. +- a remix, in haskell_, of John Wiegley's excellent c++ ledger_. hledger + reads most standard ledger files and vice-versa. **hledger aims to be...** @@ -22,9 +18,9 @@ hledger **To get help...** -- chat me (sm) on the `#ledger irc channel `_ which we share with ledger -- join the `hledger google group `_ -- for something private, `email me `_. +- chat me (sm) on the `#ledger irc channel`_ which we share with ledger +- join the `hledger google group`_ +- for something private, `email me`_. Bug reports and/or patches are appreciated, for website issues, unclear/stale/missing docs, or any difficulty encountered while @@ -32,42 +28,30 @@ installing, using, or contributing. Download -------- -hledger works on all major platforms, but does not yet have binaries or platform packages; -you'll need to install `GHC `_ and `cabal -`_, then -install hledger from `hackage -`_ with: -``cabal install hledger`` + +hledger works on all major platforms, but does not yet have binaries or +platform packages; you'll need to install GHC_ and cabal_, then install +hledger from hackage_ with: ``cabal install hledger`` Documentation ------------- -`User's Guide `_ -| `News `_ -| c++ ledger's `home page `_ -and `manual `_ +`User's Guide`_ | News_ | see also `ledger's home page`_ and manual_ -`Developer API docs `_ -| `Developer Notes `_ -| `Contributor List `_ -| latest `benchtest `_, -`profile `_, -`heap `_ -reports +`Developer API docs`_ | `Developer Notes`_ | `Contributor List`_ | latest benchtest_, profile_, heap_ reports Screenshots ----------- - .. raw:: html - - - + + + Code repository --------------- ``darcs get http://joyful.com/repos/hledger`` -or `browse with darcsweb `_. New patches are announced on #ledger by hledgerbot. +or `browse with darcsweb`_. New patches are announced on #ledger by hledgerbot. .. raw:: html @@ -75,11 +59,44 @@ or `browse with darcsweb `_. Related projects ---------------- -- `ledger `_ inspired hledger, and the two projects are coevolving. If you like hledger, try ledger too. -- Tim Docker's `ledger-reports `_ uses hledger as a library to generate `html reports `_. +- ledger_ inspired hledger, and the two projects are coevolving. If you like hledger, try ledger too. +- 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 . -.. easy analytics access .. raw:: html + + +.. _`ledger file`: http://joyful.com/repos/hledger/sample.ledger +.. _balance: http://hledger.org:5000/balance +.. _register: http://hledger.org:5000/register?a=checking +.. _hledger google group: http://groups.google.com/group/hledger +.. _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 +.. _benchtest: http://joyful.com/repos/hledger/profs/latest.bench +.. _profile: http://joyful.com/repos/hledger/profs/latest.prof +.. _heap: http://joyful.com/repos/hledger/profs/latest.ps +.. _browse with darcsweb: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger +.. _email me: mailto:simon@joyful.com +.. _Simon Michael: http://joyful.com +.. _haskell: http://haskell.org +.. _GHC: http://haskell.org/ghc +.. _cabal: http://haskell.org/cabal/download.html +.. _hackage: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hledger +.. _#ledger irc channel: irc://irc.freenode.net/#ledger +.. _ledger: http://wiki.github.com/jwiegley/ledger +.. _ledger's 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 + + +.. rst quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html + +.. Local variables: +.. mode: rst +.. End: