slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc:examples: expand READMEs, clarify status for examples

Browse Source
This commit is contained in:
Simon Michael 2024-01-05 08:16:55 -10:00
parent 03f6864e60
commit cc403d5ff9
2 changed files with 33 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
examples/README.md
View File

@ -1 +1,17 @@
Sample data files: journals, time logs, CSV rules..
Here in examples/ you'll find a mixed bag of sample journals, time logs, CSV rules, scripts, etc.
Like the Cookbook docs, these vary in age and quality; "examples" here does not mean "exemplary".
Some may be ready to use; some are to be studied and adapted; some are just for interest; some are outdated and best ignored.
The content here is not necessarily stable but here are some subcategories as of 2024-01:
- budgeting - some budgeting-related journals
- costs - some examples of cost notation
- a growing collection of rules and maybe helper scripts you can use and adapt for reading real world CSV/TSV/SSV files
- dungeons-and-dragons - a nifty example of dungeon master accounting
- i18n - examples of non-ascii data and account declarations in different languages
- investing - a place to collect investing-related journal entries
- invoicing - scripts and templates for generating invoices
- reporting - scripts related to producing reports
- self-tracking - a mini-tutorial on working with Marek Gibney's "Syntax for Self-Tracking" logging format
- systemd - an example of systemd service configuration for hledger-web
- templates - a start at gathering "clean starter file sets for various needs" (2021)

17
examples/invoicing/README.md
View File

@ -1 +1,16 @@
Example files related to https://hledger.org/invoicing.html
Example files related to invoicing and billing:
- invoice-script - a somewhat flexible bash/pandoc script for generating HTML and PDF invoices from hledger data,
based on SM's invoicing setup (2022)
- makefile - a simpler make/pandoc script for generating HTML and PDF invoices, with less hledger integration,
based on SM's previous setup (2021)
- some examples of invoicing-related journal entries
The SM scripts above aim to have a pretty good likelihood of working and being useful for others,
but they try to automate repetitive steps in my process as much as possible,
so they may try to run emacs, append to your journal, or git commit it;
read them before running, and adapt for your needs.
See also https://hledger.org/cookbook.html#invoicing