summaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
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 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index d758794c..86a34e08 100644
--- a/README.md
+++ b/README.md
@@ -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)