Commits

drozdyuk committed d371679

Added example of adding plugin and dirty

Comments (0)

Files changed (1)

+Setup
+-------
+1. Setup symlinks
+2. Initialize the plugins
+
+Symlinks
+----------
+Windows
+========
+Assume we cloned the repository into "C:\Users\john\configurations\vimfiles". 
+Then from your home directory (e.g. ``C:\Users\john``)::
+
+C:\Users\john> mklink /D vimfiles C:\Users\john\configurations\vimfiles
+C:\Users\john> mklink .vimrc C:\Users\john\configurations\vimfiles\.vimrc
+C:\Users\john> mklink .gvimrc C:\Users\john\configurations\vimfiles\.gvimrc
+
+Linux
+======
+Create symlinks to folder and files, as in windows.
+
+Initialize the plugins
+----------------------
+
+    git submodule init
+    git submodule update
+
+Installing new plugins
+----------------------
+
+From zip
+========
+Simply unzip them into the "bundles" folder, e.g.:
+
+   bundle/pluginFolder
+
+From remote Git and such
+===========================
+Add them as a submodule to the "bundles" folder. 
+
+Example
+~~~~~~~
+To add plugin such as `tabular` (https://github.com/godlygeek/tabular), we first 
+strip out the "https" and use just "http", and then add it as a submodule to our `bundle`
+directory:
+
+    git submodule add http://github.com/godlygeek/tabular bundle/tabular
+    git commit -a -m "Added tabular plugin"
+    
+Dirty status
+~~~~~~~~~~~~
+Sometimes when you do `git status` a submodule will show up as dirty. To fix this
+go into `.gitmodules` file and add `ignore = dirty` attribute to the affected plugin. E.g.:
+
+	[submodule "bundle/nerdtree"]
+	path = bundle/nerdtree
+	url = http://github.com/vim-scripts/The-NERD-tree.git
+	ignore = dirty