diff options
| author | Alberto Corona <ac@albertocorona.com> | 2017-01-07 15:19:30 -0600 |
|---|---|---|
| committer | Joe Wilm <jwilm@users.noreply.github.com> | 2017-01-09 09:23:32 -0800 |
| commit | 987b8555def9b321d8388d7ca8290d214bc51c4a (patch) | |
| tree | fcd79875adb6fc0430c3beb61b5db651a6295b9a /README.md | |
| parent | 2fa271419c4765f7758dcf336fe0b913c12c18a6 (diff) | |
Conform to XDG spec for configuration
- Use $XDG_CONFIG_HOME/alacritty/alacritty.yml for loading the
configuration file falling back to $HOME/.config/alacritty/alacritty.yml
- Closes #203
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 9 insertions, 3 deletions
@@ -138,9 +138,15 @@ cp Alacritty.desktop ~/.local/share/applications ### Configuration Although it's possible the default configuration would work on your system, -you'll probably end up wanting to customize it anyhow. There is an -`alacritty.yml` at the git repository root. Copy this to either -`$HOME/.alacritty.yml` or `$XDG_CONFIG_HOME/alacritty.yml` and run Alacritty. +you'll probably end up wanting to customize it anyhow. There is a default +`alacritty.yml` at the git repository root. Alacritty looks for the configuration +file as the following paths: + +1. `$XDG_CONFIG_HOME/alacritty/alacritty.yml` +2. `$HOME/.config/alacritty/alacritty.yml` + +If these files are not found then one is created as `$HOME/.config/alacritty/alacritty.yml` +once alacritty is first run. Many configuration options will take effect immediately upon saving changes to the config file. The only exception is the `font` and `dpi` section which |