Add configuration instructions to the README

This commit is contained in:
Jonas 'cherti' Große Sundrup 2020-07-25 13:18:12 +02:00
parent 9f82cbaa49
commit 38ba3f5429
No known key found for this signature in database
GPG key ID: 5B587ADC0531D442

View file

@ -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