hledger/doc/site/index.md

126 lines
4.9 KiB
Markdown
Raw Normal View History

2014-11-12 03:39:22 +03:00
% home
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
# hledger is...
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
### a lightweight, dependable, cross-platform accounting program
2014-11-12 01:55:23 +03:00
hledger is a computer program for easily tracking money, time, or
2014-11-12 03:39:22 +03:00
other commodities, on unix, mac and windows. With simple yet powerful
functionality accessed from command line or web browser, it is a
reliable, flexible, future-proof alternative to Quicken or GnuCash. I
use it for:
- tracking spending and income
- seeing time reports by day/week/month/project
- getting accurate numbers for client billing and tax filing
- tracking invoices
- building financial and time clarity and serenity
<div style="margin:0 10em 0 5em;">
### Free software
hledger is available under the GNU GPLv3+, which helps ensure that it
will remain free and available for as long as you need it. It has
been developed as a community project by
[Simon Michael](http://joyful.com) and
[contributors](contributors.html) since 2007.
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 10em 0 10em;">
### inspired by Ledger
2014-11-12 01:55:23 +03:00
hledger was inspired by and maintains substantial compatibility with [Ledger](faq.html#hledger-and-ledger),
and is part of the enthusiastic and supportive "*ledger" community.
2014-11-12 03:39:22 +03:00
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 20em 0 0em;">
2014-11-12 01:55:23 +03:00
### a command-line tool, that preserves your data
hledger is first a command-line tool. It follows Ledger's philosophy:
your data lives in a simple, safe, plain text file which you can edit
any way you wish; hledger reads that file and produces reports of
various kinds, without changing your data. (It can help you add new
2014-11-12 03:39:22 +03:00
transactions, but does not change existing ones.)
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 10em 0 5em;">
2014-11-12 01:55:23 +03:00
### ...with a web UI
hledger comes with a built-in web server providing an alternate
2014-11-12 03:39:22 +03:00
[browser-based interface](manual.html#web), for assisted data entry
and point and click reporting. The web and command-line clients can be
used simultaneously.
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 5em 0 10em;">
2014-11-12 01:55:23 +03:00
### a Haskell application and library
hledger is written in Haskell, a modern and highly-regarded
programming language which contributes to hledger's robustness,
performance and long-term maintainability. Most functionality is
exposed as reusable Haskell
[libraries](http://hackage.haskell.org/package/hledger-lib), making it
easy to write your own hledger-compatible
2014-11-12 03:58:18 +03:00
[scripts](more-docs.html#scripting-examples), [add-ons](manual.html#add-ons) and
2014-11-12 01:55:23 +03:00
applications.
2014-11-12 03:39:22 +03:00
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 20em 0 0em;">
2014-11-12 01:55:23 +03:00
### documented
2014-11-12 03:39:22 +03:00
Complete, accurate documentation is always a top priority.
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 15em 0 5em;">
2014-11-12 01:55:23 +03:00
### comfortable for techies, usable by all
hledger aims to be useful to both computer experts and regular folks.
Currently it is a bit more suited to power users, who appreciate the
power of text files, revision control, scriptability and double entry
accounting. The web interface helps make it accessible to GUI-only
folk as well.
2014-11-12 03:39:22 +03:00
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
<div style="margin:0 10em 0 10em;">
2014-11-12 01:55:23 +03:00
### focussed on serving the user
hledger strives to be accessible, practical and to provide real-world value.
2014-11-12 03:39:22 +03:00
I've been depending on and improving it continuously since 2007.
2014-11-12 01:55:23 +03:00
I needed a tool like this badly, and I want to keep it growing and helping others who can also benefit.
2014-11-12 03:39:22 +03:00
(You can help!)
</div>
2014-11-12 01:55:23 +03:00
2014-11-12 03:39:22 +03:00
## get started
2014-11-12 01:55:23 +03:00
You could:
2014-11-12 03:39:22 +03:00
**[download](download.html)**,\
read the **[tutorial](step-by-step.html)**,
2014-11-12 03:39:22 +03:00
the **[manual](manual.html)**,
or the **[blog posts & articles](more-docs.html#blog-posts-articles)**,\
or ask questions on **[#hledger](http://hledger.org/irc)**
or the **[mail list](http://hledger.org/list)**.
<!-- <style> -->
<!-- tr { -->
<!-- /*vertical-align:top;*/ -->
<!-- border-top:thin solid #bbb; -->
<!-- } -->
<!-- </style> -->
2014-11-12 01:55:23 +03:00
|---------------------------|-------------------------------------------------------------------------
| IRC | [#hledger](http://hledger.org/irc) (see also [#ledger](http://webchat.freenode.net?channels=ledger&randomnick=1))
| Mail list&nbsp;&nbsp; | [list.hledger.org](http://hledger.org/list)
| Twitter | [#ledgercli](https://twitter.com/search?q=%23ledgercli&src=typd&f=realtime), <a href="https://twitter.com/ledgertips">@LedgerTips</a>
| Github | [code.hledger.org](http://github.com/simonmichael/hledger)
| More...&nbsp;&nbsp; | [Quick links](http://hledger.org/developer-guide.html#quick-links)
<!-- | web UI demo | [demo.hledger.org](http://demo.hledger.org) | -->
<!-- [web ui demo](http://demo.hledger.org/register?q=inacct%3Aassets%3Abank%3Achecking+sym%3A\%24) -->
<div style="margin-top:2em; text-align:right; float:right;">
<!-- Has hledger saved you or your employer money, time or peace of mind ? -->
<!-- Donations: -->
**[Gittip](https://www.gittip.com/simonmichael/)**,
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a>
<!-- Also testimonials, examples, blogging, packaging, and patches. -->
</div>