aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-08-29 21:11:11 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-08-29 21:11:11 +0000
commit8fa6b5fa2dc2d31700ce92391cfa7e095296f562 (patch)
tree0f1b8aa9b8384eaf90c5243a7ebe3b68720b950f
parentREADME: hopefully fix nested lists (diff)
README: add an 'installation' section
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index c79c9525..dc08ce83 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,9 @@
1. [Requirements](#requirements)
1. [Running](#running)
1. [Building](#building)
+1. [Installing](#installing)
+ 1. [Arch Linux](#arch-linux)
+ 1. [Other](#other)
1. [Fonts](#fonts)
1. [Shortcuts](#shortcuts)
1. [Keyboard](#keyboard)
@@ -57,6 +60,24 @@ In addition to the dev variant of the packages above, you need:
* scdoc
+## Installing
+
+### Arch Linux
+
+Use [makepkg](https://wiki.archlinux.org/index.php/Makepkg) to build
+the bundled `PKGBUILD`.
+
+
+### Other
+
+Foot uses _meson_. If you are unfamiliar with it, the official
+[tutorial](https://mesonbuild.com/Tutorial.html) might be a good
+starting point.
+
+I also recommend taking a look at that bundled Arch `PKGBUILD` file,
+to see how it builds foot.
+
+
## Fonts
**foot** supports all fonts that can be loaded by _freetype_,