diff options
author | Craig Earls <enderw88@gmail.com> | 2014-03-27 18:22:50 -0700 |
---|---|---|
committer | Craig Earls <enderw88@gmail.com> | 2014-03-27 18:22:50 -0700 |
commit | c2f52c1d521bdae3cb0d8a6db60646c7b20d0a76 (patch) | |
tree | 4076544376fc6ef8b147b6a23f3326966d624be6 | |
parent | 7903abe0c2e88c3d97b257405d13aa8a4e42a296 (diff) | |
parent | 71535a4c07ed1158d97ad73d296f01a619102fcc (diff) | |
download | fork-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...
-rw-r--r-- | README.md | 13 | ||||
-rw-r--r-- | doc/README | 64 |
2 files changed, 12 insertions, 65 deletions
@@ -7,6 +7,15 @@ 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. +Ledger uses text files for input. It reads the files and generates reports; +there is no other database or stored state. To use Ledger, you create a +file of your account names and transactions, run from the command line with +some options to specify input and requested reports, and get output. +The output is generally plain text, though you could generate a graph or +html instead. Ledger is simple in concept, surprisingly rich in ability, +and easy to use. + + ## For the Impatient I know, you just want to build and play. If you have all the dependencies @@ -54,7 +63,8 @@ much further with those. ## Dependencies If you wish to proceed in this venture, you'll need a few dependencies. The -easiest way to get them for your platform is to run: +easiest way to get them for your platform is to run this handy Python +script: ./acprep dependencies @@ -154,6 +164,7 @@ You can run `make check` to confirm the result, and `make install` to install. Now that you're up and running, here are a few resources to keep in mind: - [Home page](http://ledger-cli.org) + - [Documentation](http://www.ledger-cli.org/docs.html) - [IRC channel](irc://irc.freenode.net/ledger) - [Mailing List / Forum](http://groups.google.com/group/ledger-cli) - [GitHub project page](http://github.com/ledger/ledger) 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. |