From 2d3553531d1e5210280ec8f66fb041d0ee4b2802 Mon Sep 17 00:00:00 2001 From: miruka Date: Tue, 19 Jan 2021 11:43:41 -0400 Subject: [PATCH] Better explain XDG vs default locations in docs --- docs/CONFIG.md | 9 ++++++--- src/config/settings.py | 3 ++- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 998b47ae..09a9b879 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -9,9 +9,12 @@ On Linux: -- `$XDG_CONFIG_HOME/mirage` or `~/.config/mirage` for config files -- `$XDG_DATA_HOME/mirage` or `~/.local/share/mirage` for user data -- `$XDG_CACHE_HOME/mirage` or `~/.cache/mirage` for cache data +- `$XDG_CONFIG_HOME/mirage` if the `XDG_CONFIG_HOME` environment variable is + set, else `~/.config/mirage` for config files +- `$XDG_DATA_HOME/mirage` if that variable is set, else `~/.local/share/mirage` + for user data +- `$XDG_CACHE_HOME/mirage` if that variable is set, else `~/.cache/mirage` + for cache data For Flatpak installations: diff --git a/src/config/settings.py b/src/config/settings.py index a8321443..40bbf91a 100644 --- a/src/config/settings.py +++ b/src/config/settings.py @@ -24,7 +24,8 @@ class General: # Application theme to use. # Can be the name of a built-in theme (Mirage.qpl or Glass.qpl), or # the name (including extension) of a file in the user theme folder, which - # is "$XDG_DATA_HOME/mirage/themes" or "~/.local/share/mirage/themes". + # is "$XDG_DATA_HOME/mirage/themes" if that environment variable is set, + # else "~/.local/share/mirage/themes". # For Flatpak, it is # "~/.var/app/io.github.mirukana.mirage/data/mirage/themes". theme: str = "Midnight.qpl"