Skip to content

docs: Update README.md to include windows specific instructions #33

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
dannyadair merged 2 commits into from
May 16, 2025
Merged

docs: Update README.md to include windows specific instructions #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ef69dd
docs: Update README.md to include windows specific instructions
ben05allen May 16, 2025
13f4423
docs: running precommit
ben05allen May 16, 2025
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ sudo apt install pipx
pipx ensurepath
```

#### Windows Requirements

If you are using Windows, GTK needs to be installed:
[GTK for Windows Runtime Environment Installer](https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases/download/2022-01-04/gtk3-runtime-3.24.31-2022-01-04-ts-win64.exe)

- Choose Install GTK+ libraries
- Tick to setup path (otherwise add the install dll folder manually)
- Choose your installation location
- Complete the installation

### Optional Dependencies

- For SVG to PDF conversion, [CairoSVG](https://cairosvg.org/) is used by default. If
Expand Down