darkcloud-nvimconfig/README.md

2.4 KiB

Darkcloud Vim Theme, Config and Plugin Selection

Requirements

  1. Git and Bash: Required to manage plugin updates using the "pathogen_update_plugins" script.
  2. CTags: Available @ http://ctags.sourceforge.net, this can be in $PATH or in the vim folder and is required for the tagbar plugin.
  3. Vim v7.4+: Everything has been written and tested using Vim 7.4.135, and I assume there could be issues with 7.3 and below.
  4. Powerline Fonts (optional): Required for the powerline lightline theme, which can be toggled in /etc/vimrc along with the gVim font

Installation/Setup

  1. Edit the 'vimrc' file and select whether to expect powerline fonts, choose a font for gVim, and add or change any of the loaded config files to match your personal setup.
  2. For a distro-agnostic system-wide installation in the /etc directory, copy:
  • The 'vimrc' file to '/etc/vimrc'
  • The 'vim' folder to '/etc/vim'
  1. -or- For a single-user installation in a user's home directory, copy:
  • The 'vimrc' file to '~/.vimrc'
  • The 'vim' folder to '~/.vim'
  • Note: When using the second installation type, the following line in the vimrc file isn't necessary (though it won't hurt to keep it): "set runtimepath+=/etc/vim".
  1. Make sure the 'vimrc' file and 'vim' folder are at least readable to any users that will be using the config.
  2. Clone additional vim plugin repos in the 'bundle' folder to have them loaded at startup, and you can add or replace config files in your 'vimrc' file to customize behaviour.
  3. Run the pathogen_update_plugins script to update your plugins by running 'git pull' on each folder with a '.git' directory in the bundle folder.
  4. The 'vim/config/keyboard.vim' file has a list of the commands it configures, as well as some basic examples of some provided directly by plugins (though check the plugin folder's README for a full explanation)

Credits

License

All projects cloned in the vim/bundle folder are separate and have their own licenses. Everything else is released under the MIT license.