Document stow

README.md

@@ -1,4 +1,22 @@
 # Sync
+Syncs austenwares.com offical bash/zsh/tmux/vim/... config files
+
+### Installation
+- Using Ansible
+
+    virtualenv .env
+    . .env/bin/activate
+    pip install -r requirements.txt
+    ./sync.sh TAG[,TAG2...] [ANSIBLE-OPTS]
+
+- Using stow
+
+    stow skel
+    stow vim
+
+- Installing vim
+
+    vim +'call Initialize()'
 
 ### Examples
 #### Delete everything in skel
@@ -20,31 +38,3 @@
 #### Sync for root
 
     ./sync.sh default,vim --become --ask-become-pass
-
-Sync syncs tmux/vim/bash config files with one command
-
-Usage:
-
-    usage: sync.sh [-h] [-t] [-c] [-b] [-s] [-d]
-
-    optional arguements:
-      -h  Show this help message and exit
-      -t  Syncs tmux configuration file
-      -c  Syncs other configuration files
-      -b  Syncs Vim bundles
-      -s  Syncs computer with server applications in server.txt
-      -d  Syncs computer with desktop applications in desktop.txt
-
-Or, install vim bundles and vimrc, customizing which bundles you use first (requires `curl` and `vim` packages):
-
-    mkdir -p ~/.vim/plugin/ ~/.vim/backup/ ~/.vim/undo/ ~/.vim/tmp/ ~/.vim/bundle/ ~/.vim/bundle/ ; if [ ! -f ~/.vim/plugin/sessionman.vim ] ; then curl -o ~/.vim/plugin/sessionman.vim http://www.vim.org/scripts/download_script.php?src_id=15599 ; fi ; if [ ! -d ~/.vim/bundle/vundle/ ] ; then git clone https://github.com/gmarik/vundle.git ~/.vim/bundle/vundle ; fi ; curl -o ~/.vimrc -k https://austenwares.com/gitlab/stonewareslord/Sync/raw/master/vimrc ; vim ~/.vimrc +"execute \"normal /Bundle 'gmarik\/vundle'\<CR>\"" +"execute \"normal :nohlsearch\<CR>:function Save()\<CR>w\<CR>BundleInstall\<CR>qa\<CR>endfunction\<CR>\"" +"nnoremap <F2> :call Save()<CR>:so ~/.vimrc<CR>:BundleInstall<CR>" ; echo "Installation should be complete. Run \"vim\" to check"
-
-Usage: run this command and it will automatically load the bundle list with descriptions of each. Delete the ones you don't want to install and press `F2` in normal mode to install al at once.
-
-Or, temporarily load the bashrc (requires `curl` package):
-
-    curl -k -o /tmp/tmprc https://gitea.austenwares.com/stonewareslord/Sync/raw/master/tmprc && . /tmp/tmprc ; rm /tmp/tmprc
-
-Or, clone the sync project and add all origins automatically:
-
-    mkdir sync&&cd sync&&git init&&git remote add testorigin https://gitea.austenwares.com/stonewareslord/Sync.git&&git config http.sslVerify false&&git pull testorigin master&&. bashrc&&git remote rm testorigin&&initify stonewareslord Sync -r