summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8786519..74f8cc5 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,12 @@
This repository contains my personal config files.
* `nixos/` -- contains my [NixOS](https://nixos.org/) configurations
+* `user/` -- contains my dotfiles
+
+The idea behind this structure is that dotfiles like my
+ZSH config can also easily be used on non-NixOS systems.
+
+Note that I'm intentionally not setting my `XDG_CONFIG_HOME` to the `user/`
+directory to prevent this repo from becoming dirty by automatically generated
+files that I don't care about (I also don't want to use a blanket gitignore).
+So I'm symlinking the files in `user/` into `XDG_CONFIG_HOME` via `link-user`. \ No newline at end of file