This project is configuration for the Vim text editor.
It is aimed to keep vim light and efficient and should be
usable for anyone who know how to use this editor.
It should not confilct with your habbit if you are fammiliar with Vim.

This project use pathogen to keep each plugin in a separate folder (bundle).
Plugins are include as submodules and so stay under responsibility of their creators.

Copyright (C) 2016 Charles Gueunet

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

INSTALL

##Once you have backed up your old .vim and .vimrc :

  cd ~  
  git clone --recursive https://github.com/CharlesGueunet/vimconf.git .vim  
  ln -sf .vim/.vimrc .  

If you have already cloned this repo without the --recursive you can use :

  git submodule update --init  

To install ctags (or choose your distribution version if you can):

   cd ctags  
   ./configure  
   make  
   sudo make install  

by default ctags use zsh if it is installed (or bash otherwise)
change syntastic shell to your convenient if needed in the vimrc file.

For Python users, the flake8-vim plugin might require the flake8 Python package. To install it, you can use :

   pip install --user flake8

CONFIG

###Templates :

• c.vim :
  Edit the file bundle/c.vim/c-support/template/Templates with your informations
  other templates are here

• snippets completion:
  files are in bundle/vim-snippets/snippets
  Each file is on the for : extension.snippets

• doc:
  You can add the doc of the wanted plugins with :

  :helptags ~/.vim/bundle/PLUNGIN/doc

Where PLUGIN is the wanted plugin.

USE

• We assume you know how to use vim
• The leader key is ","

Navigation

(try to use buffer navigation, cool with nerdTree ((Leader n))

• (Leader v) to vertical split
• (Leader h) to horizontal split
• (Leader left or right) to go to the dezired buffer
• (Leader bottom) to list buffers
• (Leader top) to change buffer
• (Leader > or <) to go to desired windows
• (CTRL+ w arrow) to go to the dezired windows (split)
• (Leader o) to maximize/unmaximizer current windows among splitted
• (Leader b) open ctags menu, allow travel btw functions & variables

Files navigation

• (Leader n) open NerdTree : file navigator menu
• (Leader f) open NerdTree on current location

Words

• Fast travel with (Leader Leader w)
• cs'" to change 'test' in "test" (change surround)
• in Visual selection : maj+S allow to put surround mark arround the selected block :
  maj+S { will sourround the block with {}
• Interactively replace word under cursor using (Leader r)
• Interactive substitute (%s) using (Leader s)

Indent

• (Leader ig to have indentation guide
• C and C++ can be indented with (CTRL k) (current line / selection)
  this indentation use clang formatter. to personalise put
  .clang-format file in the project root (one is given in example in the git)
• To align text on a given char : :Tab/<char>
• Shorcut exist for = and : with (Leader a= (or :a)).
• You can fold your current scope ('{ ... }') by pressing (Leader -)

Tips

• mouse enabled, use maj when selecting text to allow ctrl-maj-c
• XML autocomplete juste write the body and then tab : p TAB -> <p></p>
  Custom tag autocomplete when created : <toto> -> <toto>| </toto>
• (Leader p) show your current regiser, allowing you to retrieve old pasted lines ("0p for example)
• you can add bookmark to a line with "mm" and navigate through bookmarks with mp and mn
• Add text to your bookmark with mi

Completion

• The completion use JetBrain style : Ctrl-Space.
• You can use snippets with tab (example : inc -> #include <| >)
  reminder snippets are in bundle/vim-snippets/snippets
• Bracket, char string... are auto-closed automatically
• to insert c function with c.vim : \if, \im ... cf :h csupport

Code tips

• (Leader s) to deactivate / reactivate syntax verification on save (Syntastic)
• (Leader c space) to comment
• (Leader c u) to uncomment
• on command mode : maj K give you the doc of the function under cursor
• (Leader l) to go to the corresponding tag on the tagbar (for function, fields ...)
• • and _ allows to select and expand / shrink selection

Syntastic

• You can force a silent check with (Leader c) and make the error windows appear with (Leader e)
• for syntastic to work properly in your project you may need to indicate some files to include or some flags for the compiler.
  A sample file for C++ is include here : .syntastic_cpp_config.
  This file should be next to the source file opened in vim.

GIT

This git is maintained by Charles Gueunet <charles.gueunet+vimconf@gmail.com>