summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Merriam <charles.merriam@gmail.com>2014-03-27 17:41:36 -0700
committerCharles Merriam <charles.merriam@gmail.com>2014-03-27 17:41:36 -0700
commite591326dc6b87a041f07f94e424f008e02e40cf1 (patch)
treef478a62b2a27c7a18f45f4cb50dd9860419cc53f /README.md
parentc9a6ad9b4899531ae1ed07579fd1a4a6add9cb65 (diff)
downloadfork-ledger-e591326dc6b87a041f07f94e424f008e02e40cf1.tar.gz
fork-ledger-e591326dc6b87a041f07f94e424f008e02e40cf1.tar.bz2
fork-ledger-e591326dc6b87a041f07f94e424f008e02e40cf1.zip
Update README.md; more introduction and documentation link
Updated the introduction with the little information that was unique to doc/README. Also added a link to the documentation page.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index ed0a5bfa..5f861c00 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,14 @@ 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 storing state. To use Ledger, you create a
+file of your account names and transactions, run from the command line with
+command lines options to specify a report, and get output. The output is
+generally plain text, though one 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
@@ -145,6 +153,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)