Skip to content

Update README file #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2025
Merged

Update README file #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down