summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRasmus Steinke <rasi@xssn.at>2017-10-30 17:18:20 +0100
committerRasmus Steinke <rasi@xssn.at>2017-10-30 17:18:20 +0100
commit6fac194311bef10536205491d9cf82ddfa2835e0 (patch)
treed618ebe69251f4812e1901efdf71e71ecda86de9
parent87ba1479583ca2fb86e4c46881cdd8b745543da9 (diff)
downloadclerk-6fac194311bef10536205491d9cf82ddfa2835e0.tar.gz
clerk-6fac194311bef10536205491d9cf82ddfa2835e0.tar.bz2
mention variables
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7f8e82c..625d513 100644
--- a/README.md
+++ b/README.md
@@ -40,17 +40,14 @@ for the tagging_client:
### Arch Linux
* install [clerk-git from AUR](https://aur.archlinux.org/packages/clerk-git/)
-* run clerk_setup as user
### Debian/Ubuntu
* install deb package from [release page](https://github.com/carnager/clerk/releases)
-* run clerk_setup as user
### Others
* Install dependencies
-* Copy `clerk.conf` and `clerk.tmux` to `$HOME/.config/clerk/config` and edit paths to database file and clerk.tmux
* Copy `clerk` and `clerk_rating_client` scripts to $PATH and make them executable.
* Run clerk
@@ -130,3 +127,16 @@ C-q: quit clerk tmux interface
```
All tmux hotkeys can be changed in clerk.tmux file.
+
+## Files and Variables
+
+clerk Uses $XDG_CONFIG_HOME to store it's files. Normally this variable is not set
+and defaults to $HOME/.config.
+
+Files used:
+
+`clerk.conf`: config file.
+`clerk.tmux`: clerk's tmux config
+`database.mpk`: clerk's local database
+
+Use `CLERK_CONF`, `CLERK_TMUX` and `CLERK_DATABASE` variables to override file locations.