From dd76be0e82d492b14dbc0a8e5dcf2a2f251c043a Mon Sep 17 00:00:00 2001
From: Matt Singleton <matt@xcolour.net>
Date: Wed, 10 Feb 2021 16:35:01 -0600
Subject: improve docs

---
 README.md | 6 ++++--
 deploy.sh | 3 +++
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 22c6ff8..0c8d64f 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@ The script does the following:
  * Clear out `$PWD/dotfiles-backup/`.
  * Symlink everything under `config` into `$XDG_CONFIG_HOME`. Moves everything
    that already exists to `$PWD/dotfiles-backup/` first.
- * Symlink `vimrc` and `zshrc` into `$HOME`. Again back up existing files to
+ * Symlink everything under `home` into `$HOME`. Again back up existing files to
    `$PWD/dotfiles-backup`.
  * Clone Vundle into `~/.vim/bundle/vundle/` and run `BundleInstall`.
- * Create `~/.zshrc-local` if one doesn't already exist.
+ * Copy files under `local` into the appropriate locations only if they don't
+   already exist. These are for handling local configuration that shouldn't or
+   can't be version controlled.
diff --git a/deploy.sh b/deploy.sh
index 17318bd..114dc09 100755
--- a/deploy.sh
+++ b/deploy.sh
@@ -2,6 +2,7 @@
 
 set -e
 
+# clean out old backups
 rm -rf dotfiles-backup
 mkdir -p dotfiles-backup
 
@@ -35,6 +36,7 @@ do
 done
 cd ..
 
+# install vundle for vim
 if [ ! -d ~/.vim/bundle/vundle ]; then
     git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle
     cd ~/.vim/bundle/vundle
@@ -44,6 +46,7 @@ fi
 vim +BundleInstall +qall
 vim +BundleClean +qall
 
+# create local files
 if [ ! -e config/zsh/00-local.zsh ]; then
     cp local/local.zsh config/zsh/00-local.zsh
 fi
-- 
cgit v1.2.3