From 38ba3f5429af2966a1448e41f90f0b259abe0adc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20=27cherti=27=20Gro=C3=9Fe=20Sundrup?= Date: Sat, 25 Jul 2020 13:18:12 +0200 Subject: [PATCH] Add configuration instructions to the README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e1e88b8..233703d1 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ The fast, lightweight and minimalistic Wayland terminal emulator. ## Index 1. [Features](#features) +1. [Configuration](#configuration) 1. [Troubleshooting](#troubleshooting) 1. [Why the name 'foot'?](#why-the-name-foot) 1. [Fonts](#fonts) @@ -34,7 +35,6 @@ The fast, lightweight and minimalistic Wayland terminal emulator. 1. [Bugs](#bugs) 1. [Mastodon](#mastodon) - ## Features * Fast (see [benchmarks](doc/benchmark.md)) @@ -53,6 +53,14 @@ The fast, lightweight and minimalistic Wayland terminal emulator. ![wow](doc/sixel-wow.png "Sixel screenshot") +## Configuration + +**foot** can be configured by creating a file `$XDG_CONFIG_HOME/footrc` (defaulting to `~/.config/footrc`). +A template for that can usually be found in `/usr/share/foot/footrc` or +[here](https://codeberg.org/dnkl/foot/src/branch/master/footrc). + +Further information can be found in foot's manpage `foot(5)`. + ## Troubleshooting