diff options
author | Alan Pearce | 2015-04-12 10:03:26 +0100 |
---|---|---|
committer | Alan Pearce | 2015-04-12 10:03:26 +0100 |
commit | 058a156b6d5306ebdc853773631d0304f5a4e73b (patch) | |
tree | b248ceeed15233bd7a469e854fff5444f2f10cdb | |
parent | 5f38bf11558b0c3736123c70b1cc25fd7bfc435d (diff) | |
download | ynab-ledger-main.tar.xz ynab-ledger-main.zip |
-rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6a8dfa --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,41 @@ | |||
1 | ## Introduction | ||
2 | |||
3 | This is just a hacky import script that reads YNAB exports (budget and | ||
4 | register) and produces ledger output to stdout. | ||
5 | |||
6 | ## What it does | ||
7 | |||
8 | It transforms the budget into a set of virtual transactions at the | ||
9 | first of the month (or the day of the opening balance, for the first | ||
10 | month) balanced against the Assets account. Categorised transactions | ||
11 | are exported with a non-balanced virtual posting to reduce the | ||
12 | category amount. It guesses whether an account should be an asset or | ||
13 | a liability by its starting balance (anything positive denotes an | ||
14 | asset), or by the presence of “credit” in the account name. Memos are | ||
15 | transformed into comments, either on the transaction or, for split | ||
16 | transactions, on each posting. | ||
17 | |||
18 | ## Status | ||
19 | |||
20 | It mostly works and has served its purpose for me. It doesn’t work so | ||
21 | well with off-budget accounts, although transferring into them seems | ||
22 | fine, if they have any income it will not be categorised correctly. | ||
23 | |||
24 | I don’t expect to develop this further, unless there is specific need. | ||
25 | I haven’t tested it with currencies other than the British Pound. Let | ||
26 | me know if something doesn’t work (ideally with some test data) and | ||
27 | I’ll try to fix it. | ||
28 | |||
29 | If you want to fix it yourself, go ahead. I’ll merge any pull request | ||
30 | that looks reasonable and works with my own data. | ||
31 | |||
32 | ## Usage | ||
33 | |||
34 | ``` | ||
35 | composer install | ||
36 | ./main.php convert /path/to/budget.csv /path/to/register.csv > new-ledger-file.dat | ||
37 | ``` | ||
38 | |||
39 | ## License | ||
40 | |||
41 | The project is licensed under the BSD 3-Clause License. | ||