vitorbritto / setup-vim

My personal VIM Configuration.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

VIM Setup

My personal VIM Configuration.

Requirements

Vim 7.3 or better (Tested on Mac OS )

Introduction to Vim: http://blog.interlinked.org/tutorials/vim_tutorial.html

  • Homebrew - ruby -e "$(curl -fsSL https://gist.github.com/raw/323731/install_homebrew.rb)"
  • MacVim - brew install macvim
  • Homesick - gem install homesick
  • discount - brew install discount
  • ctags - brew install ctags

MacVim is not a requirement as the majority of the files work in most *nix environments including Terminal. It's recommended to use Homebrew's package of MacVim, as it compiles MacVim and Vim at 64 bit with Ruby, Python, Perl, installs the command line link mvim, plus a bunch of other goodness. Homesick is required for easy management of dot files with the repository. The discount executable is recommended for converting markdown files to html for previewing. The ctags executable is helpful for taglist (jumping between files) and omni completion.

Installing

To install the files and default configuration run the following:

Quick Install

$ bash -c "$(curl -fsSL raw.github.com/vitorbritto/setup-vim/master/init.sh)"

Normal Install

# Backup for your existing VIM configuration
$ mv ~/.vim ~/.vim_bkp && mv ~/.vimrc ~/.vimrc_bkp && mv ~/.gvimrc ~/.gvimrc_bkp

# Installation
$ git clone --recursive http://github.com/vitorbritto/setup-vim.git .vim
$ ln -s ~/.vim/vimrc ~/.vimrc
$ ln -s ~/.vim/gvimrc ~/.gvimrc
$ rm -rf ~/.vim/init.sh

Plugins

Plug-ins are managed using pathogen. All submodule plug-ins are stored in the bundle directory.

Adding New Plug-Ins As Submodules

New plug-ins need to be added to the bundle directory and should be treated as submodules. To add a new one run:

$ git submodule add <repository> ~/.vim/bundle/<plugin-name>
$ git submodule init
$ git submodule update

Update Plugins (Upgrading all bundled plugins)

To pull upstream changes for all of the submodules run the following:

$ cd ~/.vim
$ git submodule foreach git pull origin master

Sync Setup (Installing Vim environment on another machine)

To sync this environment on another machine run the following:

$ cd ~
$ git clone http://github.com/vitorbritto/setup-vim.git ~/.vim
$ ln -s ~/.vim/vimrc ~/.vimrc
$ cd ~/.vim
$ git submodule init
$ git submodule update

Removing Submodules

  • Delete the relevant line from the .gitmodules file
  • Delete the relevant section from .git/config
  • Run git rm --cached path_to_submodule (no trailing slash!!)
  • Remove the directory from bundle
  • Remove any descriptions from the README.md file

Default Plug-Ins

Helpful Stuff

Acknowledgments

License

MIT License © Vitor Britto

About

My personal VIM Configuration.


Languages

Language:Vim Script 39.1%Language:Ruby 27.1%Language:C 16.6%Language:Perl 10.4%Language:Shell 6.8%