docs: cleanups, fix warnings, fix screenshots in pdf

This commit is contained in:
Simon Michael 2010-02-13 20:24:52 +00:00
parent c31e200d4e
commit 553358087f
6 changed files with 36 additions and 27 deletions

View File

@ -22,11 +22,13 @@ Also:
- John Wiegley - created the original ledger program - John Wiegley - created the original ledger program
.. raw:: html .. raw:: html
<br> <br>
---- ----
.. raw:: html .. raw:: html
<br> <br>
hledger Contributor Agreement hledger Contributor Agreement
@ -44,7 +46,7 @@ changes to hledger, please sign this, to help ensure:
(eg GPLv2 -> GPLv3) (eg GPLv2 -> GPLv3)
To "sign", read the conditions below and then send a darcs patch to To "sign", read the conditions below and then send a darcs patch to
this file_ adding your name to the Contributor List above. By so `this file`_ adding your name to the Contributor List above. By so
doing you promise that all of your commits to hledger: doing you promise that all of your commits to hledger:
- are free of patent violations or copyright violations, to the best of - are free of patent violations or copyright violations, to the best of
@ -62,5 +64,5 @@ Feel free to update your entry as your contributions grow!
.. _license: http://joyful.com/repos/hledger/LICENSE .. _license: http://joyful.com/repos/hledger/LICENSE
.. _file: http://joyful.com//darcsweb/darcsweb.cgi?r=hledger;a=filehistory;f=/CONTRIBUTORS .. _this file: http://joyful.com//darcsweb/darcsweb.cgi?r=hledger;a=filehistory;f=/CONTRIBUTORS

2
MANUAL
View File

@ -393,7 +393,7 @@ main ledger.
.rules file .rules file
,,,,,,,,,,, ,,,,,,,,,,,
convert requires a *.rules file containing data definitions and rules for convert requires a \*.rules file containing data definitions and rules for
assigning destination accounts to transactions; it will be auto-created if assigning destination accounts to transactions; it will be auto-created if
missing. Typically you will have one csv file and one rules file per bank missing. Typically you will have one csv file and one rules file per bank
account. Here's an example rules file for converting csv data from a Wells account. Here's an example rules file for converting csv data from a Wells

25
NEWS
View File

@ -60,12 +60,8 @@ hledger news
* refactoring, clearer data types * refactoring, clearer data types
Stats: Stats:
62 days since last release, 62 days, 2 contributors, 76 commits since last release.
2 contributors, Now at 3464 lines of non-test code, 97 tests, 53% test coverage.
76 commits,
3464 lines of non-test code,
97 tests,
53% test coverage
2009/12/11 hledger 0.7 2009/12/11 hledger 0.7
........................ ........................
@ -103,12 +99,8 @@ hledger news
* many site and documentation updates * many site and documentation updates
Stats: Stats:
1 contributors, 60 days, 1 contributor, 50 commits since last release.
60 days since release, Now at 3377 lines of non-test code, 97 tests, 53% test coverage.
50 commits,
3377 non-test code lines,
97 tests,
53% test coverage
2009/06/22 hledger 0.6.1 2009/06/22 hledger 0.6.1
........................ ........................
@ -182,8 +174,9 @@ Release stats:
* Lines of non-test code: 2795 * Lines of non-test code: 2795
* Tests: 76 * Tests: 76
* Known errors: 0 * Known errors: 0
* Performance:
.. ..
* Performance:
|| hledger-0.4 | hledger-0.5 | ledger || hledger-0.4 | hledger-0.5 | ledger
=========================++=============+=============+======= =========================++=============+=============+=======
-f sample.ledger balance || 0.01 | 0.01 | 0.06 -f sample.ledger balance || 0.01 | 0.01 | 0.06
@ -226,8 +219,9 @@ Release stats:
* Lines of non-test code: 2367 * Lines of non-test code: 2367
* Tests: 56 * Tests: 56
* Known errors: 0 * Known errors: 0
* Performance:
.. ..
* Performance:
|| hledger-0.3 | hledger-0.4 | ledger-0.3 || hledger-0.3 | hledger-0.4 | ledger-0.3
==============================++=============+=============+=========== ==============================++=============+=============+===========
-f sample.ledger balance || 0.02 | 0.01 | 0.07 -f sample.ledger balance || 0.02 | 0.01 | 0.07
@ -261,8 +255,9 @@ Release stats:
* Lines of non-test code: 2123 * Lines of non-test code: 2123
* Tests: 58 * Tests: 58
* Known errors: 1 * Known errors: 1
* Performance:
.. ..
* Performance:
$ bench hledger-0.2 hledger ledger $ bench hledger-0.2 hledger ledger
|| hledger-0.2 | hledger | ledger || hledger-0.2 | hledger | ledger
==================================++=============+=========+======= ==================================++=============+=========+=======

8
README
View File

@ -14,13 +14,13 @@ I use it every day to:
- get accurate numbers for client billing and tax filing - get accurate numbers for client billing and tax filing
- track invoices - track invoices
Here is a **demo_** of the web interface. Here is a demo_ of the web interface.
Here are ready-to-run **binaries_** for mac, windows and gnu/linux. Here are ready-to-run binaries_ for mac, windows and gnu/linux.
Unfortunately they are not always the latest release, sorry about that. Unfortunately they are not always the latest release, sorry about that.
Here is the **manual_**. Here is the manual_.
For support and more technical info, see **`hledger for techies`_** or **`email me`_**. For support and more technical info, see `hledger for techies`_ or `email me`_.
.. (If you're reading this in plain text, see also README2, MANUAL etc., or http://hledger.org) .. (If you're reading this in plain text, see also README2, MANUAL etc., or http://hledger.org)

View File

@ -33,6 +33,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
`developer notes`_ `developer notes`_
.. raw:: html .. raw:: html
<a name="support" /> <a name="support" />
**Support** **Support**
@ -40,6 +41,7 @@ hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3.
- chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_ - chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_
- report problems in the `issue tracker`_ - report problems in the `issue tracker`_
- .. raw:: html - .. raw:: html
<form action="http://groups.google.com/group/hledger/boxsubscribe" > <form action="http://groups.google.com/group/hledger/boxsubscribe" >
join the <a href="http://hledger.org/list">hledger mail list</a>. Your email: join the <a href="http://hledger.org/list">hledger mail list</a>. Your email:
<input type=text name=email><input type=submit name="sub" value="Subscribe"> <input type=text name=email><input type=submit name="sub" value="Subscribe">

View File

@ -1,6 +1,7 @@
hledger screenshots hledger screenshots
=================== ===================
.. ....................................................................
.. raw:: html .. raw:: html
<br><br><a name=hledger-screen-1> <br><br><a name=hledger-screen-1>
@ -8,8 +9,10 @@ hledger screenshots
Basic command-line reports, like ledger: Basic command-line reports, like ledger:
.. image:: hledger-screen-1.png .. image:: hledger-screen-1.png
:width: 571px
:height: 400px
.. ....................................................................
.. raw:: html .. raw:: html
<br><br><a name=sshot> <br><br><a name=sshot>
@ -17,8 +20,10 @@ Basic command-line reports, like ledger:
The interactive curses interface ("hledger ui"): The interactive curses interface ("hledger ui"):
.. image:: sshot.png .. image:: sshot.png
:width: 802px
:height: 378px
.. ....................................................................
.. raw:: html .. raw:: html
<br><br><a name=watchhours> <br><br><a name=watchhours>
@ -26,8 +31,10 @@ The interactive curses interface ("hledger ui"):
A time dashboard in emacs. The upper window displays today's time report every minute (using ansi-term, watch, a helper script, and hledger invoked via "hours" symlink.) The lower window is viewing the timelog file, to tweak clock-ins/clock-outs made with C-x t i and C-x t o. (`ledgerutils.el <http://joyful.com/Ledger/#ledgertools>`_ has some related bits.): A time dashboard in emacs. The upper window displays today's time report every minute (using ansi-term, watch, a helper script, and hledger invoked via "hours" symlink.) The lower window is viewing the timelog file, to tweak clock-ins/clock-outs made with C-x t i and C-x t o. (`ledgerutils.el <http://joyful.com/Ledger/#ledgertools>`_ has some related bits.):
.. image:: watchhours.png .. image:: watchhours.png
:width: 756px
:height: 502px
.. ....................................................................
.. raw:: html .. raw:: html
<br><br><a name=hledger-charts-2> <br><br><a name=hledger-charts-2>
@ -35,5 +42,8 @@ A time dashboard in emacs. The upper window displays today's time report every m
Viewing a year of monthly expense charts in emacs. See examples in http://hledger.org/MANUAL#chart . Viewing a year of monthly expense charts in emacs. See examples in http://hledger.org/MANUAL#chart .
.. image:: hledger-charts-2.png .. image:: hledger-charts-2.png
:width: 1675px
:height: 1004px
:scale: 50
:target: hledger-charts-2.png