diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2020-07-28 18:51:54 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2020-07-28 18:51:54 +0000 |
| commit | e802fd4c9ec03b62165e8c1533d102af7d6f3de0 (patch) | |
| tree | 9782bddf1b3a3237f5e234922fa193cc4a8eb20c /INSTALL.md | |
| parent | readme: now that the install section is so short, move it up (diff) | |
readme: move 'requirements' into INSTALL.md
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 42 |
1 files changed, 42 insertions, 0 deletions
@@ -1,6 +1,9 @@ # Installing 1. [Overview](#overview) +1. [Requirements](#requirements) + 1. [Running](#running) + 1. [Building](#building) 1. [Arch Linux](#arch-linux) 1. [Other](#other) 1. [Setup](#setup) @@ -27,6 +30,45 @@ https://codeberg.org/dnkl/fcft.git and https://codeberg.org/dnkl/tllist.git (see [Other](#other) below). +## Requirements + +### Running + +* fontconfig +* freetype +* pixman +* wayland (_client_ and _cursor_ libraries) +* xkbcommon +* [tllist](https://codeberg.org/dnkl/tllist) [^1] +* [fcft](https://codeberg.org/dnkl/fcft) [^1] + +[^1]: can also be built as subprojects, in which case they are + statically linked. + + +### Building + +In addition to the dev variant of the packages above, you need: + +* meson +* ninja +* wayland protocols +* ncurses +* scdoc + +A note on compilers; in general, foot runs **much** faster when +compiled with gcc instead of clang. A profile-guided gcc build can be +more than twice as fast as a clang build. + +**Note** GCC 10.1 has a performance regression that severely affects +foot when doing PGO builds and building with `-O2`; it is about 30-40% +slower compared to GCC 9.3. + +The work around is simple: make sure you build with `-O3`. This is the +default with `meson --buildtype=release`, but e.g. `makepkg` can +override it (`makepkg` uses `-O2` by default). + + ## Arch Linux Install from AUR: |
