1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..736058a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# dotfiles
+
+This utilises [GNU stow](https://www.gnu.org/software/stow/).  In case you don't know how to use it:
+
+``` shell
+stow -t ~ -R <pkg>
+```
+
+So, you can do stuff like:
+
+``` shell
+stow -t ~ -R environment
+stow -t ~ -R zsh
+```
+
+Or simply:
+
+``` shell
+stow -t ~ -R *
+```
+
+Note that this repo contains a lot of dotfiles (files named with . in front).
+This might make them be invisible with `ls` :).
+
+## Important notes
+
+Before stowing anything, you should probably run `./init-skel` to make sure some generic directories don't end up linked
+to this repo.
+
+After stowing `emacs`, make sure `.emacs.d` doesn't exist.  Kill all active emacs sessions (incl. daemons) and
+`rm -fr ~/.emacs ~/.emacs.el ~/.emacs.d` (of course, first make sure they don't contain anything important).  Then start
+a new Emacs session and check whether any of them have been recreated.  If yes, there's some issue.