From fbc1faadc9e74c9f8e046f527f0e8d5b7678c6d3 Mon Sep 17 00:00:00 2001 From: Tobias Bieniek Date: Sat, 13 Sep 2025 17:50:50 +0200 Subject: [PATCH] Update README file This commit updates the "Requirements" section and documents the two additional environment variables that can be used. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31f5742..cfb58d1 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,11 @@ The generated images include: ## Requirements -- The [Typst](https://typst.app/) CLI must be installed and available in your `PATH` +- The [Typst](https://typst.app/) CLI must be installed and available in your `PATH` (or configured via the `TYPST_PATH` environment variable). +- The [Fira Sans](https://github.com/mozilla/Fira) font must be installed on your system (or configured via the `TYPST_FONT_PATH` environment variable). +- The [Noto CJK](https://github.com/notofonts/noto-cjk) font may optionally be installed for CJK character support. +- The [Noto Color Emoji](https://github.com/googlefonts/noto-emoji/) font may optionally be installed for Emoji support. +- The [oxipng](https://github.com/shssoichiro/oxipng) CLI may optionally be installed for PNG file size optimization. ## Usage @@ -65,7 +69,11 @@ async fn main() -> Result<(), OgImageError> { ## Configuration -The path to the Typst CLI can be configured through the `TYPST_PATH` environment variables. +The following environment variables can be used to configure the image generation: + +- `TYPST_PATH` - Path to the Typst CLI binary +- `TYPST_FONT_PATH` - Additional font directory +- `OXIPNG_PATH` - Path to the `oxipng` binary for PNG optimization ## Development