aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-08-17 10:42:28 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-08-17 10:42:28 +0000
commita421c2ad600778aa47917be29e3449a0941e2fd1 (patch)
treed92ef84d5ef46fd05527b9ef1d6b5cd0e9296582
parentmeson: remove unused wayland protocols (diff)
README: split up requirements into "running" and "building"
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index e338c51a..392623fb 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,29 @@
# foot
-**foot** is a Wayland terminal emulator.
+**foot** is a fast Wayland terminal emulator.
## Requirements
+### Running
+
* fontconfig
* freetype
* pixman
* wayland (_client_ and _cursor_ libraries)
-* wayland protocols
* xkbcommon
+### Building
+
+In addition to the dev variant of the packages above, you need:
+
+* meson
+* ninja
+* wayland protocols
+* scdoc
+
+
## Fonts
**foot** supports all fonts that can be loaded by freetype, including