From 3ec0824d3ea359c8ec5a19ad56894b16670d8566 Mon Sep 17 00:00:00 2001 From: Martchus Date: Thu, 23 Nov 2023 18:53:13 +0100 Subject: [PATCH] Update outdated link in "Providing the font file" section * Releases seem to be no longer present * Link directly to the relevant directories/files * Mention the automatic download before going into all the details of supplying the files manually --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 78ead0d..e4b9af6 100644 --- a/README.md +++ b/README.md @@ -22,16 +22,22 @@ and set `PERL_BIN` to the path of `perl.exe` from the MSYS2 installation. ### Providing the font file Of course the font file and icon definitions for ForkAwesome need to be -supplied as well. -Just download an archive from https://github.com/ForkAwesome/Fork-Awesome/releases -and specify its path via the CMake variables `FORK_AWESOME_FONT_FILE` -and `FORK_AWESOME_ICON_DEFINITIONS`, e.g. add -`-DFORK_AWESOME_FONT_FILE=/path/to/Fork-Awesome-1.2.0/fonts/forkawesome-webfont.woff2` +supplied as well. If none of the variables mentioned in the next paragraph are +specified, the build system will attempt to download the files from GitHub +automatically. + +To supply the files manually, just download the `ttf`, `woff` or `woff2` +file from +[ForkAwesome's fonts directory](https://github.com/ForkAwesome/Fork-Awesome/tree/master/fonts) +and the +[icon definitions file](https://github.com/ForkAwesome/Fork-Awesome/blob/master/src/icons/icons.yml). +Then specify the path of the downloaded files via the CMake variables +`FORK_AWESOME_FONT_FILE` and `FORK_AWESOME_ICON_DEFINITIONS`, e.g. add +`-DFORK_AWESOME_FONT_FILE=/path/to/Fork-Awesome/fonts/forkawesome-webfont.woff2` and -`-DFORK_AWESOME_ICON_DEFINITIONS=/path/to/Fork-Awesome-1.2.0/src/icons/icons.yml` +`-DFORK_AWESOME_ICON_DEFINITIONS=/path/to/Fork-Awesome/src/icons/icons.yml` to the CMake invocation. The font file will be built into the library and -is hence only required at build time. If none of the variables are specified, -the build system will attempt to download the files from GitHub. +is hence only required at build time. The Web Open Font Format (the `.woff`/`.woff2` file) might not be supported by the font renderer. Notably, Window's native font rendering which Qt uses by