summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornicodebo <nico.debo@openmailbox.org>2017-07-20 00:44:30 +0200
committernicodebo <nico.debo@openmailbox.org>2017-07-22 17:16:08 +0200
commit518862a660e467648ca0d4f860389f3bb2d9a4ce (patch)
tree949826376ffc39b32a82dffd4c01dbb92d40d8bf /README.md
parentbad17e074fdc3686c5cabb60ab6470143c4a1924 (diff)
downloadclerk-518862a660e467648ca0d4f860389f3bb2d9a4ce.tar.gz
clerk-518862a660e467648ca0d4f860389f3bb2d9a4ce.tar.bz2
Implement xdg specification base directory
Follow xdg base directory specification, see https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html - Use $XDG_CONFIG_HOME if it is set, otherwise use $HOME/.config - Use $XDG_DATA_HOME if it is set, othewise use $HOME/.local/share - split the clerk files between those two hereabove metionned directories by keeping the clerk/config and clerk/podcasts inside $XDG_CONFIG_HOME, and the rest inside $XDG_DATA_HOME - Put all the file variables definition in a centralized location for easier maintenance. - Updated the README to reflect the XDG support
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index f6638e6..3bf5926 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,8 @@ For this to work, you need a recent rofi build from git.
# Installation
1. Install dependencies (each binary needs to be in your $PATH)
-2. Copy config.clerk to $HOME/.config/clerk/config and edit it.
+2. Copy config.clerk to $XDG_CONFIG_HOME/clerk/config if $XDG_CONFIG_HOME is
+ set, otherwise copy it to $HOME/.config/clerk/config and edit it.
3. Copy clerk and clerk_helper to $PATH
4. Run clerk