Skip to content

Commit 0564da3

Browse files
committed
Update README
1 parent ef54b86 commit 0564da3

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.org

+15-12
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,31 @@
1414
:CUSTOM_ID: what-is-it
1515
:END:
1616

17-
=hledger-flow= is a command-line program that gives you a guided
18-
[[https://hledger.org/][Hledger]] workflow. It focuses on automated
19-
processing of electronic statements as much as possible, as opposed to
20-
manually adding your own hledger journal entries.
17+
=hledger-flow= is a command-line program that gives you a guided [[https://hledger.org/][Hledger]]
18+
workflow. It is important to note that most of the heavy lifting is done by the
19+
upstream =hledger= project. For example, =hledger-flow= cares about where you
20+
put your files for long-term maintainability, but the actual conversion to
21+
classified accounting journals are done by =hledger=.
2122

22-
Manual entries are still possible, it just saves time in the long run to
23-
automatically process a statement whenever one is available.
23+
=hledger-flow= focuses on automated processing of electronic statements as much as possible,
24+
as opposed to manually adding your own hledger journal entries. Manual entries
25+
are still possible, it just saves time in the long run to automatically process
26+
a statement whenever one is available.
2427

2528
Within =hledger-flow= you will keep your original bank statements around
2629
permanently as input, and generate classified Hledger journals each time
27-
you run the program. The classification is done with rules files, or
28-
your own script hooks.
30+
you run the program. The classification is done with [[https://hledger.org/csv.html][hledger's rules files]],
31+
and/or your own script hooks.
2932

3033
Keeping the original statements means that you never have to worry too
3134
much about "am I doing this accounting thing right?" or "what happens if
3235
I make a mistake?". If you want to change your mind about some
3336
classification, or if you made a mistake, you just change your
3437
classification rules, and run the program again.
3538

36-
It started when I realized that the scripts I wrote while playing around
37-
with the ideas in [[https://github.com/adept/full-fledged-hledger/wiki][adept's Full-fledged Hledger]] aren't really specific to
38-
my own finances, and can be shared.
39+
It started when I realized that the scripts I wrote while playing around with
40+
[[https://github.com/adept/full-fledged-hledger/wiki][adept's Full-fledged Hledger]] aren't really specific to my own finances, and can
41+
be shared.
3942

4043
* Overview of the Basic Workflow
4144
:PROPERTIES:
@@ -726,7 +729,7 @@ different.
726729

727730
| Full-fledged Hledger | Hledger Flow |
728731
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
729-
| FFH is a [[https://github.com/adept/full-fledged-hledger/wiki#full-fledged-hledger-tutorial][tutorial]] with helper scripts that you can start using and adapt to your needs. | I started by following the FFH tutorial, and changed bits and pieces over time to suit my needs. The "owner/bank/account" structure for example. |
732+
| FFH is a [[https://github.com/adept/full-fledged-hledger/wiki#full-fledged-hledger-tutorial][tutorial with helper scripts]] that you can start using and adapt to your needs. | I started with FFH, and changed bits and pieces over time to suit my needs. The "owner/bank/account" structure for example. |
730733
| | |
731734
| FFH is more open-ended: you can start with the basic scripts and over time turn it into something that solves your needs exactly. But you'll also end up with more code that you need to maintain yourself. | Hledger Flow is more opinionated and less open-ended. For example, you have to adopt the "owner/bank/account" structure precisely as specified. But this allows Hledger Flow to do more work for you. |
732735
| | |

0 commit comments

Comments
 (0)