summaryrefslogtreecommitdiff
path: root/README
blob: 50d7c7a284e3391edbe1936e91b9b85277ba669f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Welcome to Ledger, a command-line accounting program.

Quick start
===========

To build Ledger, you will first need these two libraries installed:

    gmp        GNU multi-precision library
    pcre       Perl regular expression library

If you wish to read Gnucash data files, you will also need two XML
libraries, which may or may not be available in a single package (it
depends on your distribution):

    xmlparse
    xmltok

Once you have determined where the headers and libraries for the above
packages are installed, run the script "configure", passing those
paths.  If you installed everything under /usr/local, you can probably
just type "./configure".  Otherwise, do this:

    ./configure CPPFLAGS=-I<INCLUDE-PATH>  LDFLAGS=-L<LIBRARY-PATH>

If you need to specify multiple include or library paths, then do
this:

    ./configure CPPFLAGS="-I<PATH1> -I<PATH2>"  LDFLAGS="-L<PATH1> -L<PATH2>"

Once configure is done running, just type:

    make install

Building Ledger as a Python Module
==================================

If you have Python 2.2 or higher installed, and Boost.Python, then
Ledger will also be built as a Python module.  This means you can
interact with your Ledger data from Python, making it easier to write
very custom reporting code.  See the developer documentation for
information on Ledger's interfaces, and for some example reports
written in Python.