summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEkaitz Zarraga <ekaitz@elenq.tech>2020-08-23 19:52:48 +0200
committerEkaitz Zarraga <ekaitz@elenq.tech>2020-08-23 19:52:48 +0200
commitd016b8fa231162cc9dc11c5696e35cde24abb8ab (patch)
tree291c7d000191febfe9210032a292f4b2aba8de08
parentb427661237f7b00155cbe82caa8644e7b22c5f4f (diff)
Add example config file just in case
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5edb28a..aa47bbb 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,37 @@ file in `$XDG_CONFIG_HOME/fracture/config` (`XDG_CONFIG_HOME` falls back to
`$HOME/.config`). If configuration file is already set it will load the current
configuration file for you to edit.
+You can use this example file as start:
+
+```ini
+[invoice]
+id_format = "%%d/%%d/%%d/%%04d" %% (series, date.year, int(date.month/3+1), id)
+template = template.latex
+
+# Currency related, just the amount of decimal places and the currency to use.
+currency = €
+currency_decimal = 2
+
+[series]
+# This are the series *I* have, you can use any.
+1 = Telecom
+2 = Teaching
+3 = Publishing
+4 = Correction
+
+[taxes]
+# This are the extra taxes that you may apply to your earnings.
+# Both key and value are used later.
+IRPF = -0.15
+
+[vat]
+# Those names are not used, but are good for you to know what you mean
+general = 0.21
+reducido = 0.10
+superreducido = 0.04
+exento = 0.00
+```
+
## Storage
Storage is done in the configuration directory (for the moment).
@@ -24,3 +55,4 @@ store the invoice in the database.
## TODO
+There is stuff to do but I didn't list it yet.