commit 2818e27e5ebb8be1a27d99a3fffe71ead00db133
parent 4f09f26f132e4bd30bcaf67928ab0aa66f86d268
Author: Martin Klöckner <mjkloeckner@gmail.com>
Date: Thu, 25 Sep 2025 11:32:34 -0300
updated `README.md`
Diffstat:
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -21,25 +21,34 @@ OPTIONS:
## Dependencies
-- [Pandoc](https://pandoc.org/)
-- [Inter font](https://fonts.google.com/specimen/Inter)*
-- [Fira math font](https://github.com/firamath/firamath)*
+This is a [Pandoc](https://pandoc.org/) wrapper, so pandoc is the main
+dependency. For generating the PDF pandoc mainly uses latex packages, so having
+latex installed is required, in particular if you have Arch Linux the following
+latex packages are recommended for a general build without errors:
+
+```console
+sudo pacman -S texlive-fontsextra texlive-fontsrecommended texlive-langother
+texlive-latexextra texlive-binextra texlive-plaingeneric texlive-formatsextra
+```
-\* The last 2 are optional, depenting on the style of the generated PDF
+The included `style.tex` file uses external fonts, for the base text and
+sections titles the font [Inter](https://github.com/rsms/inter) is used (which
+is similar to [Helvetica](https://en.wikipedia.org/wiki/Helvetica)) and [Fira
+math](https://github.com/firamath/firamath) for the math fonts. Of course the
+fonts are optional since latex already includes base fonts.
## Installation
If you want to install this script to your system, copy the executable to
`$HOME/.local/bin` or to `/usr/bin` if you want to install it user-wide or
-system-wide respectively. Make sure to also move the corresponding style files
-if used to the same folder
+system-wide respectively.
- User wide:
-```shell
+```console
$ cp ./md2pdf $HOME/.local/bin
```
- System wide:
-```shell
+```console
# cp ./md2pdf /usr/bin
```
