diff --git a/DEVELOPMENT.rst b/DEVELOPMENT.rst index 8e45d993e..158a46b3f 100644 --- a/DEVELOPMENT.rst +++ b/DEVELOPMENT.rst @@ -4,47 +4,10 @@ title: hledger development hledger development =================== -**Techie intro** - -hledger_ is a remix, in haskell_, of John Wiegley's excellent ledger_ accounting tool. -It reads a plain text journal_ or timelog_ file describing your transactions -and displays reports via command line, curses or web interfaces. - -The hledger project aims to produce: - -- 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. - -**Learn** - news_, manual_, screenshots_, `some extra tips`_ - -**Download** - ``cabal install hledger``, - or try these ready-to-run binaries_, - or see the `installing docs `_ - -**Develop** - ``darcs get http://joyful.com/repos/hledger``, - `browse the repo`_, - `hackage page`_, - `hledger haddock docs`_, - benchmark_\/profile_\/heap_\/coverage_ reports, - `developer notes`_ - - .. `hledger-lib sourcegraph report`_, - .. `hledger sourcegraph report`_, - -.. raw:: html - - - -**Support** +**Support** for users and developers: - chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_ -- report problems at `bugs.hledger.org `_ (`grid `_) +- `report `_ problems at `bugs.hledger.org `_ (`view all `_) - share and test journal snippets at paste . hledger.org - .. raw:: html @@ -53,18 +16,42 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. -**Related projects** +**Goals:** the hledger project aims to produce -- John Wiegley's ledger_ inspired hledger. -- 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 `_. +- 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. + +**Code:** + + :: + + darcs get --lazy http://joyful.com/repos/hledger + cd hledger + make or make install + + `Release notes`_, + `browse the repo`_, + `hackage page`_, + `combined api docs`_, + benchmark_\/profile_\/heap_\/`coverage reports`_, + `developer notes`_ + +.. `hledger-lib sourcegraph report`_, +.. `hledger sourcegraph report`_, .. raw:: html +**Related projects** + +- John Wiegley's ledger_ inspired hledger. +- h/ledger inspired Uwe Hollerbach's umm_. +- Tim Docker's ledger-reports_ builds on hledger to generate `html reports`_. +- I have a few older bits and pieces `here `_. + .. _hledger: README.html .. _journal: http://joyful.com/repos/hledger/data/sample.journal @@ -74,18 +61,15 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. .. _web interface: http://demo.hledger.org .. _mail list: http://list.hledger.org .. _issue tracker: http://bugs.hledger.org -.. _binaries: http://hledger.org/binaries/ -.. _manual: MANUAL.html -.. _news: NEWS.html -.. _screenshots: SCREENSHOTS.html -.. _hledger haddock docs: http://hledger.org/api-doc/ +.. _Release notes: NEWS.html +.. _combined api docs: http://hledger.org/api-doc/ .. _hledger-lib sourcegraph report: http://joyful.com/repos/hledger/hledger-lib/SourceGraph/hledger-lib.html .. _hledger sourcegraph report: http://joyful.com/repos/hledger/SourceGraph/hledger.html .. _developer 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 -.. _coverage: http://hledger.org/profs/coverage/hpc_index_fun.html +.. _coverage reports: http://hledger.org/profs/coverage/hpc_index_fun.html .. _browse the repo: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger .. _email me: mailto:simon@joyful.com?subject=hledger: .. _Simon Michael: http://joyful.com @@ -97,4 +81,3 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. .. _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 -.. _some extra tips: http://podcastle.org/2009/10/09/pc-miniature-38-accounting-for-dragons/ diff --git a/MANUAL.markdown b/MANUAL.markdown index 7a82f11aa..39e32ab8b 100644 --- a/MANUAL.markdown +++ b/MANUAL.markdown @@ -7,8 +7,8 @@ title: hledger manual ## About hledger is a program for tracking money, time, or any other commodity, -using a directly editable file format and the simple but powerful -principles of double-entry accounting. It was inspired by [ledger](#faq). +using a simple, editable file format and the powerful principles of +double-entry accounting. It was inspired by [ledger](#faq). hledger's basic function is to read a plain text file describing (eg) financial transactions, and quickly generate useful reports via the @@ -18,10 +18,10 @@ on the web. You can use it to, eg: -- track spending and income -- track unpaid or due invoices -- track time and report by day/week/month/project -- get accurate numbers for client billing and tax filing +- track spending and income +- track unpaid or due invoices +- track time and report by day/week/month/project +- get accurate numbers for client billing and tax filing hledger aims to help both computer experts and regular folks gain clarity in their finances. For the moment, it may be a little more suited to @@ -57,9 +57,8 @@ Or, you can build the latest [development](DEVELOPMENT.html) version: $ cd hledger $ make install -If you have any trouble, please proceed to -[Troubleshooting](#troubleshooting) for help and/or seek -[Support](DEVELOPMENT.html#support). +If you have any trouble, please see [Troubleshooting](#troubleshooting) +and/or seek [Support](DEVELOPMENT.html#support). ## Usage @@ -268,7 +267,7 @@ Here are the commands hledger supports. Note, #### add -Note: this command can append to your journal file. +*This command can append to your journal file.* The add command prompts interactively for new transactions, and appends them to the journal file. Each transaction is appended when you complete @@ -411,8 +410,7 @@ Notes: #### histogram The histogram command displays a quick bar chart showing transaction -counts, per day, week, month or other reporting interval. It is -experimental. +counts by day, week, month or other reporting interval. Examples: @@ -480,7 +478,7 @@ Examples: The following commands are optional add-ons. Here is their availability: - in the binaries on the download page, they are included where possible - *(currently web on all platforms, vty on all but windows, chart on none)* + *(currently: web on all platforms, vty on all but windows, chart on none?)* - when cabal installing the current release, they are enabled by flags (see [installing](#installing)). - in the next release, they will be provided by separate packages (eg @@ -529,7 +527,7 @@ Examples: *Requires GHC 6.12 or greater.* -Note: this command can edit or overwrite your journal file. +*This command can edit or overwrite your journal file.* The web command starts hledger's web interface, and tries to open a web browser to view it. (If this fails, you'll have to manually visit the url @@ -1174,3 +1172,4 @@ Here are some issues you might encounter when you run hledger: Also the [c++ ledger 2.x manual](http://joyful.com/repos/ledger/doc/ledger.html) is slightly outdated but informative. +- [Why you need accounting](http://podcastle.org/2009/10/09/pc-miniature-38-accounting-for-dragons)