summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2005-07-15 00:56:04 +0000
committerJohn Wiegley <johnw@newartisans.com>2008-04-13 02:41:16 -0400
commit059843b1cf1d8227080596700fc21464c7be8496 (patch)
treeb55bc012ea2351ebec381eec6ec46612aaa1f172 /README
parentc29eed174de09e1477ee31c87cf3e2f2dd445b9e (diff)
downloadfork-ledger-059843b1cf1d8227080596700fc21464c7be8496.tar.gz
fork-ledger-059843b1cf1d8227080596700fc21464c7be8496.tar.bz2
fork-ledger-059843b1cf1d8227080596700fc21464c7be8496.zip
*** empty log message ***
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 31 insertions, 6 deletions
diff --git a/README b/README
index 8ebea764..01cf21dd 100644
--- a/README
+++ b/README
@@ -1,8 +1,33 @@
- Welcome to Ledger, a command-line accounting program.
+ Welcome to Ledger
-Quick start
-===========
+ the command-line accounting program
+
+Introduction
+============
+
+Ledger is an accounting program which is invoked from the command-line
+using a textual ledger file. To start using Ledger, you will need to
+create such a file containing your financial transactions. A sample
+has been provided in the file "sample.dat". See the documentation
+(ledger.pdf, or ledger.info) for full documentation on creating a
+ledger file and using Ledger to generate reports.
+
+Once you have such a file -- you might call it "ledger.dat" -- you can
+start looking at balances and account registers using commands like
+the following:
+
+ ledger -f ledger.dat balance assets:checking
+ ledger -f ledger.dat register expenses:food
+
+This assumes, of course, that like the sample file you use account
+names such as "Assets:Checking" and "Expenses:Food". If you use other
+account names, you will need to vary the reporting commands you use
+accordingly.
+
+
+Building
+========
To build Ledger, you will need a fairly modern C++ compiler (gcc 2.95
will not work), and at least these two libraries installed:
@@ -53,9 +78,9 @@ Building Ledger as a Python Module
==================================
If you have Python 2.2 or higher installed, and Boost.Python, then
-Ledger can also be built as a Python module, if --enable-python is
+Ledger can also be built as a Python module if --enable-python is
passed to the configure script. This means you can interact with your
-Ledger data from Python, making it easy to write custom reports.
+Ledger data from Python, making it easier to write custom reports.
This feature is mostly undocumented in version 2.0, although main.py
-is a working example.
+gives a working example.