1 files changed, 26 insertions, 0 deletions
diff --git a/user/README.org b/user/README.org
new file mode 100644
index 00000000..02a3a1f7
--- /dev/null
+++ b/user/README.org
@@ -0,0 +1,26 @@
+* Nixfiles
+
+I've organised this repository with [[https://rycee.gitlab.io/home-manager/][Home Manager]]. It focuses on [[http://zsh.sourceforge.net][Z
+Shell]] and [[http://emacs.sexy][Emacs]].
+
+It doesn't use any configuration frameworks, just packages installed
+via package managers.  For Z shell I use [[https://github.com/zdharma/zplugin][zplugin]] and for Emacs I use the
+built-in package.el via [[https://github.com/jwiegley/use-package][use-package]].
+
+It should work on:
+- Linux
+- macOS
+
+** Installation
+
+1. If migrating from a stow version, run =migrate.sh=.
+2. Run =install.sh=.  
+
+*** Z Shell
+
+My zsh configuration uses [[https://github.com/zdharma/zplugin][zplugin]]. I've included a setup script:
+
+#+BEGIN_SRC sh :exports code
+./zsh/config/zsh/setup.sh
+#+END_SRC
+