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