Updated the README.md

yml · Oct 19, 2017 · af30ed8 · af30ed8
1 parent 745b99c
commit af30ed8
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 33 deletions.
diff --git a/README.markdown b/README.markdown
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# Instructions
+
+## Creating source files
+
+Any file which matches the shell glob `_*` will be linked into `$HOME` as a symlink with the first `_`  replaced with a `.`
+
+For example:
+
+    _bashrc
+
+becomes
+
+    ${HOME}/.bashrc
+
+## Installing source files
+
+It's as simple as running:
+
+    ./install.sh
+
+From this top-level directory.
+
+## Install nvim
+
+    ./install_nvim.sh
+
+## Requirements
+
+* bash