Update documentation

sboehler · Dec 10, 2020 · d539d64 · d539d64
1 parent 8752387
commit d539d64
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ $ knut balance -v CHF --months --from 2020-01-01 --to 2020-04-01 doc/example.knu
     - [Infer accounts](#infer-accounts)
     - [Format the journal](#format-the-journal)
     - [Import transactions](#import-transactions)
+    - [Transcode to beancount](#transcode-to-beancount)
   - [File format](#file-format)
     - [Open and close](#open-and-close)
     - [Transactions](#transactions)
@@ -75,6 +76,7 @@ Available Commands:
   help        Help about any command
   import      Import financial account statements
   infer       Auto-assign accounts in a journal
+  transcode   transcode to beancount
 
 Flags:
   -h, --help   help for knut
@@ -382,6 +384,16 @@ Use "knut import [command] --help" for more information about a command.
 
 ```
 
+### Transcode to beancount
+
+While knut has advanced terminal-based visualization options, it lacks any web-based visualization tools. To allow the usage of the amazing tooling around the (beancount)[http://furius.ca/beancount/] ecosystem, such as (fava)[https://beancount.github.io/fava/], knut has a command to convert an entire journal into beancount's file format:
+
+```text
+knut transcode -c CHF doc/example.knut
+```
+
+This command should also allow beancount users to use knut's built-in importers.
+
 ## File format
 
 An accounting journal in knut is represented as a sequence of plain-text directives. The journal consists of a set of directives and comments. Directives are prices, account openings, transactions, value directives, balance assertions, and account closings. Lines starting with either `#` (comment) or `*` (org-mode title) are ignored. Files can include other files using an include directive. The order of the directives in the journal file is not important, they are always evaluated by date.

diff --git a/doc/README.md b/doc/README.md
@@ -24,6 +24,7 @@ knut is a plain-text, double-entry accounting tool for the command line. It prod
     - [Infer accounts](#infer-accounts)
     - [Format the journal](#format-the-journal)
     - [Import transactions](#import-transactions)
+    - [Transcode to beancount](#transcode-to-beancount)
   - [File format](#file-format)
     - [Open and close](#open-and-close)
     - [Transactions](#transactions)
@@ -130,6 +131,16 @@ knut has a few built-in importers for statements from Swiss banks:
 {{ .Commands.HelpImport }}
 ```
 
+### Transcode to beancount
+
+While knut has advanced terminal-based visualization options, it lacks any web-based visualization tools. To allow the usage of the amazing tooling around the (beancount)[http://furius.ca/beancount/] ecosystem, such as (fava)[https://beancount.github.io/fava/], knut has a command to convert an entire journal into beancount's file format:
+
+```text
+knut transcode -c CHF doc/example.knut
+```
+
+This command should also allow beancount users to use knut's built-in importers.
+
 ## File format
 
 An accounting journal in knut is represented as a sequence of plain-text directives. The journal consists of a set of directives and comments. Directives are prices, account openings, transactions, value directives, balance assertions, and account closings. Lines starting with either `#` (comment) or `*` (org-mode title) are ignored. Files can include other files using an include directive. The order of the directives in the journal file is not important, they are always evaluated by date.