Skip to content

Commit

Permalink
doc: asset_alloc
Browse files Browse the repository at this point in the history
  • Loading branch information
redstreet committed Jan 5, 2024
1 parent 08691bd commit 50ad218
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions fava_investor/modules/assetalloc_class/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Asset Allocation

Understanding the asset allocation of a portfolio is important. This module reports your
current portfolio's asset allocation, to an arbitrary asset class hierarchy and depth of
your choice.
current portfolio's asset allocation, based on an arbitrary asset class hierarchy and
depth of your choice.

## Installation
A Fava extension, a Beancount command line client, and a library are all included.
Expand All @@ -16,6 +16,25 @@ The command line client also uses the same Fava configuration shown below.

## Configuration

Price entries are needed in order for this plugin to determine the market value of the
commodities you hold. For accuracy, it helps to have recent price entries for each
commodity you own.

You probably also want to add this plugin to your Beancount ledger to help:

```
plugin "beancount.plugins.implicit_prices"
```

Accounts with negative balances are skipped with this message:

```
Warning: skipping negative balance
```

These are probably liabilities and are not considered by this plugin.


### Multi-currency portfolios
This module supports multiple currencies. See #32 on how to configure your input
correctly.
Expand Down

0 comments on commit 50ad218

Please sign in to comment.