From f5469f255bfb931b3b8c6b251b4a6b423ad85509 Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Thu, 9 Oct 2025 10:32:49 +0200 Subject: First Commit. --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2cfd59 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# Reports templating system + +This is the templating system I use to generate my reports. + +It's a (heavy) work in progress as I am still learning latex. + +it consists of a bash script that I can use to create a new markdown file for my reports and then I can use the same script to run pandoc on the markdown and output a pdf. + +## Requirements + +latex and pandoc installed. Texlive is part of slackware and the extras and pandoc packages can be obtained from [slackbuilds.org](https://slackbuilds.org). + +On my slackware64-current I have: + +- texlive-2024.240409-x86_64-4 +- texlive-extra-2024.240409-x86_64-1_SBo +- pandoc-bin-3.8-x86_64-1_SBo + +## Install + +this is the directory structure I use: + +- ~/bin + - **makereport** (the bash script) +- ~/.local/share/pandoc/templates + - **reports.latex** (the latex template) + - **reports.theme** (the color theme for the code highlighting) +- ~/Documents/reports/template/ + - **template.md** (the empty markdown template) +- ~/Pictures + - signature.png (optional signature image) + +## How to + +```bash +makereport -t > "new report.md" +``` + +This will generate the markdown with the template. + +```bash +makereport -o "new report.pdf" "new report.md" +``` + +This command will generate the pdf document. + +## Inspiration + +This script is based on the reports script by Valerio Casalino aka 5amu on github. *Grazie mille Valerio* 🫶🏻 + +## Mantainer + + * [danix](https://danix.xyz) - it's just me, really... + +## LICENSE + +makerepo © 2025 by danix is licensed under CC BY-NC 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/ \ No newline at end of file -- cgit v1.2.3