aboutsummaryrefslogtreecommitdiff
path: root/overlays/kookie/invoice/README.md
diff options
context:
space:
mode:
authorKatharina Fey <kookie@spacekookie.de>2019-10-05 13:24:18 +0000
committerKatharina Fey <kookie@spacekookie.de>2019-10-05 13:25:58 +0000
commit0a6d1447db7d1f52517a4a4c47d4198451fd223e (patch)
tree9e15a365b7ee2cd46b04d9af20b9b300967526b9 /overlays/kookie/invoice/README.md
parent1efa96a62514a89b68432f58f3235e2fa6e17d58 (diff)
Adding LIBKOOKIE overlays directories
Some of these package definitions are taken verbatim from KOOKIEPKGS, others from NIXCFG MASTER (which will be included in the history of this repository)
Diffstat (limited to 'overlays/kookie/invoice/README.md')
-rw-r--r--overlays/kookie/invoice/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/overlays/kookie/invoice/README.md b/overlays/kookie/invoice/README.md
new file mode 100644
index 00000000000..500fb5929fe
--- /dev/null
+++ b/overlays/kookie/invoice/README.md
@@ -0,0 +1,54 @@
+# invoice
+
+A tool that generates invoices with `pandoc`, `xelatex` and `yaml`.
+A descriptor file is required in order to make all of this work.
+These are independent of the tooling and template and should be
+client specific. Following is a small example of what it should
+look like:
+
+```yaml
+---
+invoice-nr: 2019-1234
+date: 2019-06-09
+author: Alice Anonymous
+city: Metropolis
+from:
+- Cyberstreet 69
+- XX51F5 Metropolis
+- alice.anonymous@mail.cyber
+- + 69 (0) 13 37 13 12
+ustid: Your Tax ID here
+bank: Evil Bank (i.e. a bank)
+bank_iban: Your IBAN
+bank_bic: Your Bank BIC
+to:
+- Client Name
+- Client Address
+- ...
+VAT: 19 # Depends on the country you live in
+service:
+- description: Looking cool
+ price: 255
+ details:
+ - Making all your other employees look silly
+ - Telling really bad jokes
+- description: Being awesome
+ price: 615
+ details: Its in the title!
+
+currency: EUR
+lang: english
+
+# Typography and layout
+fontsize: 10pt
+geometry: a4paper, left=43mm, right=43mm, top=51mm, bottom=17mm
+---
+```
+
+Then point the script at this descriptor:
+
+```
+$ invoice clients/client_name.yml
+```
+
+This will then generate `clients/client_name.pdf` as an invoice