mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-03-29 07:58:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme: move 'requirements' into INSTALL.md

Browse source
This commit is contained in:
Daniel Eklöf 2020-07-28 20:51:54 +02:00
parent e1c8da576e
commit e802fd4c9e
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 42 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

42
INSTALL.md
View file

@ -1,6 +1,9 @@
# Installing # Installing
1. [Overview](#overview) 1. [Overview](#overview)
1. [Requirements](#requirements)
1. [Running](#running)
1. [Building](#building)
1. [Arch Linux](#arch-linux) 1. [Arch Linux](#arch-linux)
1. [Other](#other) 1. [Other](#other)
1. [Setup](#setup) 1. [Setup](#setup)
@ -27,6 +30,45 @@ https://codeberg.org/dnkl/fcft.git and
https://codeberg.org/dnkl/tllist.git (see [Other](#other) below). 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 ## Arch Linux
Install from AUR: Install from AUR:

42
README.md
View file

@ -21,9 +21,6 @@ The fast, lightweight and minimalistic Wayland terminal emulator.
1. [DPI and font size](#dpi-and-font-size) 1. [DPI and font size](#dpi-and-font-size)
1. [Supported OSCs](#supported-oscs) 1. [Supported OSCs](#supported-oscs)
1. [Programmatically checking if running in foot](#programmatically-checking-if-running-in-foot) 1. [Programmatically checking if running in foot](#programmatically-checking-if-running-in-foot)
1. [Requirements](#requirements)
1. [Running](#running)
1. [Building](#building)
1. [Credits](#Credits) 1. [Credits](#Credits)
1. [Bugs](#bugs) 1. [Bugs](#bugs)
1. [Mastodon](#mastodon) 1. [Mastodon](#mastodon)
@ -345,45 +342,6 @@ responses, all at once) to determine which requests the terminal
emulator actually responded to. emulator actually responded to.
## 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).
# Credits # Credits
* [Ordoviz](https://codeberg.org/Ordoviz), for designing and * [Ordoviz](https://codeberg.org/Ordoviz), for designing and