From a030b4a88a0200383b16d6a881b20dd4b08554f4 Mon Sep 17 00:00:00 2001 From: Zemi <43094930+Ucaninek@users.noreply.github.com> Date: Wed, 5 Jun 2024 16:11:36 +0000 Subject: [PATCH] fix typos @ README.md Familiy -> Family usefull -> useful ows -> owes montly -> monthly special special -> special payed -> paid powerfull -> powerful --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d9e751c0..5683368a 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ Family Accounting Tool [![CI Status](https://github.com/nymanjens/facto/actions/workflows/ci.yml/badge.svg)](https://github.com/nymanjens/facto/actions) -Familiy Accounting Tool keeps track of every transaction your family makes. Its goal is to: +Family Accounting Tool keeps track of every transaction your family makes. Its goal is to: -- Extract usefull statistics from the data
+- Extract useful statistics from the data
_E.g.: How much is spent on food each month?_ - Calculate internal debt
_E.g.: Alice buys toilet paper for the whole family with her own money. This tool then registers - that the family ows Alice the cost of the toilet paper._ + that the family owes Alice the cost of the toilet paper._ - Provide a way to check if no money is disappearing in unexpected expenses
_E.g.: You will notice when there are hidden banking costs_ @@ -96,12 +96,12 @@ To effectively use this tool, you must learn to input the transactions correctly it's important to understand the meaning of categories and accounts. ### Categories -These are used to split up your expenses into categories. Every account has some special +These are used to split up your expenses into categories. Every account has some special categories: - **Accounting category:**
- Used for non-real income/expenses. This category will be ignored when analysing the montly - surplus/deficit in terms of expenses. Use this category e.g. when the expense will be payed + Used for non-real income/expenses. This category will be ignored when analysing the monthly + surplus/deficit in terms of expenses. Use this category e.g. when the expense will be paid back by your employer - **Endowment category:**
Used for money transfer to the common account (see example in the next section) @@ -126,9 +126,9 @@ Special fields: - **Beneficiary:**
In case of an expense: The one that will benefit from the expense
In case of an income: The one that was paid -- **Payed with/to:**
- In case of an expense: Payed with
- In case of an income: Payed to +- **Paid with/to:**
+ In case of an expense: Paid with
+ In case of an income: Paid to - **Flow:**
In case of an expense: Negative number representing the price
In case of an income: Positive number