Merge pull request #5 from digitalsparky/master

Adding some doco and such

README.md

@@ -6,8 +6,19 @@ git clone https://github.com/flipsidecreations/dotfiles.git
 
 cd dotfiles
 ```
-### Run intstall
+### Run install
 ```
 ./install.sh
 ```
 
+# Uninstallation
+
+### Change to dotfiles folder
+```
+cd ~/dotfiles
+```
+
+### Run uninstaller
+```
+./uninstall.sh
+```

install.sh

@@ -1,15 +1,20 @@
 #!/bin/bash
+
+# Find all dot files then if the original file exists, create a backup
+# Once backed up to {file}.dtbak symlink the new dotfile in place
 for file in $(find . -maxdepth 1 -name ".*" -type f  -printf "%f\n" ); do
     if [ -e ~/$file ]; then
         mv -f ~/$file{,.dtbak}
     fi
     ln -s $PWD/$file ~/$file
 done
- if hash vim-addon  2>/dev/null; then
-         echo "vim-addon (vim-scripts)  installed"
-     else
-         echo "vim-addon (vim-scripts) not installed, running 'sudo apt update; sudo apt install bc'"
-         sudo apt update; sudo apt install vim-scripts
+
+# Check if vim-addon installed, if not, install it automatically
+if hash vim-addon  2>/dev/null; then
+    echo "vim-addon (vim-scripts)  installed"
+else
+    echo "vim-addon (vim-scripts) not installed, installing"
+    sudo apt update && sudo apt -y install vim-scripts
 fi
 
 echo "Installed"

uninstall.sh

@@ -1,4 +1,7 @@
 #!/bin/bash
+
+# Loop through all the dotfiles, if the file is a symlink then remove it
+# Then if the backup file exists, restore it to it's original location
 for file in $(find . -maxdepth 1 -name ".*" -type f  -printf "%f\n" ); do
     if [ -h ~/$file ]; then
         rm -f ~/$file
@@ -7,4 +10,5 @@ for file in $(find . -maxdepth 1 -name ".*" -type f  -printf "%f\n" ); do
         mv -f ~/$file{.dtbak,}
     fi
 done
+
 echo "Uninstalled"