Added git sumodule sync to the install script and improved README

README.md

@@ -1,23 +1,28 @@
 # Getting Started
 
-Clone this (or a forked version of this) repository, and update all the git
-submodules within.
+Clone this (or a forked version of this) repository.
 
     $ cd ~
     $ git clone https://rmm5t@github.com/rmm5t/dotfiles.git .dotfiles
-    $ cd .dotfiles
-    $ git submodule update --init --recursive
 
-(Option 1) If you'd like to symlink everythin withing this repository to your
-home directory, run `install.rb`. This will also update the git submodules.
+**(Option 1)** If you'd like to symlink everything from this repository to your
+home directory, run `install.rb`. This will also sync and update all the git
+submodules within.
 
     $ cd ~/.dotfiles
     $ ./install.rb
 
-(Option 2) If you'd like to just symlink one or more configurations to your home
-directory manually, you can.
+This install script is idempotent, meaning you can run it over and over again
+without fear of breaking anything. Use it as an installer or to upgrade after
+merging from an upstream fork.
+
+**(Option 2)** If you'd like to just symlink one or more configurations to your
+home directory manually, you can.  If you take this approach, you'll have to
+update all the git submodules manually.
 
     $ cd ~/.dotfiles
+    $ git submodule sync
+    $ git submodule update --init --recursive
     $ ln -ns emacs   ~/.emacs
     $ ln -ns emacs.d ~/.emacs.d
 

install.rb

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
-# from http://errtheblog.com/posts/89-huba-huba
+# Inspired by http://errtheblog.com/posts/89-huba-huba
+
+# This is idempotent, meaning you can run it over and over again without fear of
+# breaking anything. Use it as an installer or to upgrade after merging from an
+# upstream fork.
 
 home = File.expand_path('~')
 
@@ -10,8 +14,5 @@
   `ln -ns #{File.expand_path file} #{target}`
 end
 
-# git push on commit
-# `echo 'git push' > .git/hooks/post-commit`
-# `chmod 755 .git/hooks/post-commit`
-
+`git submodule sync`
 `git submodule update --init --recursive`