ledger/doc
Charles Merriam 737d776b40 Update README to reference README.md
This older doc/README file is pure text and provides incomplete information compared to the root's README.md markdown file.  I copied over some introductory verbiage and added cross references to that file.
2014-03-26 22:36:17 -07:00
..
CMakeLists.txt Add ledger-mode.texi to the build list 2013-02-27 19:21:19 -07:00
Doxyfile.in improve doxygen build logic 2013-01-19 23:05:17 +01:00
grammar.y Untabified all source files 2010-06-11 17:02:25 -04:00
INSTALL Moved several documentation files into the 'doc' directory. 2008-08-07 23:25:42 -04:00
ledger-mode.texi Insert some spacing 2013-05-20 23:23:43 +02:00
ledger.1 Bugs 726 and 727. Remove reference to draft and lisp commands in man page 2012-10-26 09:59:20 -07:00
ledger.texi Add warning to docs about whitespace in ledger format. 2011-09-01 17:31:49 -05:00
ledger3.texi @itemx shoud be after an @item 2013-06-26 16:17:54 +02:00
LICENSE Increased copyright range to include 2009. 2009-01-20 01:53:31 -04:00
LICENSE-sha1 Renamed license file for sha1. 2009-01-23 19:50:08 -04:00
LICENSE-utfcpp Added support for Unicode text in Ledger files, thanks to 'utfcpp', which can 2009-01-23 19:50:00 -04:00
LICENSE.rtf Roel Vanhout's build files for Visual Studio 2008 2011-03-25 03:20:21 -04:00
NEWS Added NEWS entries for 2.6.2 and 2.6.3 2010-06-19 13:34:03 -04:00
README Update README to reference README.md 2014-03-26 22:36:17 -07:00

                          Welcome to Ledger

                 The Command-line Accounting Program

Introduction
============

Ledger is a powerful, double-entry accounting system that is accessed from the 
UNIX command-line. This may put off some users, since there is no flashy UI, 
but for those who want unparalleled reporting access to their data there are 
few alternatives.

To start using Ledger, you will need to create such a
file containing your financial transactions.  A sample has been provided in the
file "test/input/sample.dat".  See the Ledger 3 Manual (ledger.pdf, ledger.info, 
or http://www.ledger-cli.org/3.0/doc/ledger3.pdf) 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.

You can find more information on getting starting, building from source, and 
getting help from the ./README.md file in your ledger source repository or
online at https://github.com/ledger/ledger.


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:

    gmp        GNU multi-precision library
    pcre       Perl regular expression library

On some GNU/Linux systems, the packages you need to install are called
"gmp-dev" and "pcre-dev".  See the ./README.md in the source repository for
a more complete list of dependencies.

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


Mailing List and IRC
====================

If you need help on how to use Ledger, or run into problems, you can join the
Ledger mailing list at the following Web address:

    http://groups.google.com/group/ledger-cli

You can also find help at the #ledger channel on the IRC server
irc.freenode.net.