Improve README
This commit is contained in:
parent
be64237413
commit
db458f682d
18
README.md
18
README.md
|
@ -1,4 +1,4 @@
|
||||||
# qtforkawesome
|
# Qt ForkAwesome
|
||||||
Library that bundles ForkAwesome for use within Qt applications
|
Library that bundles ForkAwesome for use within Qt applications
|
||||||
|
|
||||||
## Build instructions
|
## Build instructions
|
||||||
|
@ -10,11 +10,12 @@ built in the same way as these libraries so checkout the `c++utilities`
|
||||||
repository for detailed instructions.
|
repository for detailed instructions.
|
||||||
|
|
||||||
To generate the header with icon definitions, Perl and the module `YAML::XS` (or
|
To generate the header with icon definitions, Perl and the module `YAML::XS` (or
|
||||||
`YAML`) are required.
|
`YAML`) are required. To use a specific Perl binary, one can set the CMake
|
||||||
|
variable `PERL`.
|
||||||
|
|
||||||
Of course the font file and icon definitions for ForkAwesome also need to be
|
Of course the font file and icon definitions for ForkAwesome need to be
|
||||||
supplied as well.
|
supplied as well.
|
||||||
Just download it from https://github.com/ForkAwesome/Fork-Awesome/releases
|
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 specify its path via the CMake variables `FORK_AWESOME_FONT_FILE`
|
||||||
and `FORK_AWESOME_ICON_DEFINITIONS`, e.g. add
|
and `FORK_AWESOME_ICON_DEFINITIONS`, e.g. add
|
||||||
`-DFORK_AWESOME_FONT_FILE=/path/to/Fork-Awesome-1.2.0/fonts/forkawesome-webfont.woff2`
|
`-DFORK_AWESOME_FONT_FILE=/path/to/Fork-Awesome-1.2.0/fonts/forkawesome-webfont.woff2`
|
||||||
|
@ -24,8 +25,13 @@ 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,
|
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.
|
the build system will attempt to download the files from GitHub.
|
||||||
|
|
||||||
Note that Web Open Font Format 2 support might require FreeType2 to be
|
Note that Web Open Font Format 2 (the `.woff2` file) might require FreeType2 to
|
||||||
configured with Brotli support.
|
be configured with Brotli support.
|
||||||
|
|
||||||
|
As usual with CMake projects, it is possible to control whether to build as
|
||||||
|
static or shared library via the `BUILD_SHARED_LIBS` variable. If you build
|
||||||
|
qtforkawesome as part of another project and only want to affect qtforkawesome,
|
||||||
|
you can also use the variable `QT_FORK_AWESOME_BUILD_SHARED_LIBS`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
The installation provides a CMake find module and a pkg-config file. Once
|
The installation provides a CMake find module and a pkg-config file. Once
|
||||||
|
|
Loading…
Reference in New Issue