summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCraig Earls <enderw88@gmail.com>2014-03-27 18:22:50 -0700
committerCraig Earls <enderw88@gmail.com>2014-03-27 18:22:50 -0700
commitc2f52c1d521bdae3cb0d8a6db60646c7b20d0a76 (patch)
tree4076544376fc6ef8b147b6a23f3326966d624be6 /doc
parent7903abe0c2e88c3d97b257405d13aa8a4e42a296 (diff)
parent71535a4c07ed1158d97ad73d296f01a619102fcc (diff)
downloadfork-ledger-c2f52c1d521bdae3cb0d8a6db60646c7b20d0a76.tar.gz
fork-ledger-c2f52c1d521bdae3cb0d8a6db60646c7b20d0a76.tar.bz2
fork-ledger-c2f52c1d521bdae3cb0d8a6db60646c7b20d0a76.zip
Merge pull request #262 from merriam/master
A pair of small documentation changes...
Diffstat (limited to 'doc')
-rw-r--r--doc/README64
1 files changed, 0 insertions, 64 deletions
diff --git a/doc/README b/doc/README
deleted file mode 100644
index 190436a2..00000000
--- a/doc/README
+++ /dev/null
@@ -1,64 +0,0 @@
-
- Welcome to Ledger
-
- 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 postings. 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:
-
- 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").
-
-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.