aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index ac5a6dd..2ff0c0b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,26 @@
---
## Installation
-Some scripts use a hardcoded location so please locate the dotfile repo
-at $HOME/.dotfiles.
-To do this run
-```git clone https://github.com/fischerling/dotfiles $HOME/.dotfiles```.
+
+For some scripts/snippets you don't know where they will be executed.
+Whenever a absolute path into the dotfile directory is needed the environment
+variable `DOTFILES_LOCATION` is used.
+
+The variable is exported in zshrc or config.fish or xinitrc.
+If you don't set it that way, please remember to export `DOTFILES_LOCATION`
+somewhere else.
+
+Good places are:
+
++ shell configs
++ at session start
+
+
+### Easy Installation
+
+If you just want to install all my dotfiles without customisation run:
+```sh
+git clone https://github.com/fischerling/dotfiles ~/.dotfiles
+cd ~/.dotfiles
+./setup.py
+```