Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@chxuan
chxuan authored Jun 14, 2016
1 parent 8306c27 commit 821727a
Showing 1 changed file with 109 additions and 107 deletions.
216 changes: 109 additions & 107 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
vimplus: An automatic configuration program for vim
===============================================
![此处输入图片的描述][1]


Intro
Expand All @@ -19,7 +20,7 @@ Installation
cd ./vimplus
sudo ./install.sh

Run the `install.sh` script will automatically install and configure vim, installation takes about 40 minutes, mainly download compiler [Valloric/YouCompleteMe][1] time-consuming, please wait until the installation is complete :smile:,**if the installation fails**, please see [Warning](#Warning).
Run the `install.sh` script will automatically install and configure vim, installation takes about 40 minutes, mainly download compiler [Valloric/YouCompleteMe][2] time-consuming, please wait until the installation is complete :smile:,**if the installation fails**, please see [Warning](#Warning).

The installation script will automatically install some software below:
- vim
Expand All @@ -31,22 +32,22 @@ The installation script will automatically install some software below:

and some plugins below:

- [Vundle][2]
- [YouCompleteMe][3]
- [NerdTree][4]
- [nerdcommenter][5]
- [Airline][6]
- [auto-pairs][7]
- [DoxygenToolkit][8]
- [ctrlp][9]
- [tagbar][10]
- [vim-devicons][11]
- [vim-surround][12]
- [vim-commentary][13]
- [tabular][14]
- [vim-dirdiff][15]
- [vim-coloresque][16]
- [change-colorscheme][17](I am the author)
- [Vundle][3]
- [YouCompleteMe][4]
- [NerdTree][5]
- [nerdcommenter][6]
- [Airline][7]
- [auto-pairs][8]
- [DoxygenToolkit][9]
- [ctrlp][10]
- [tagbar][11]
- [vim-devicons][12]
- [vim-surround][13]
- [vim-commentary][14]
- [tabular][15]
- [vim-dirdiff][16]
- [vim-coloresque][17]
- [change-colorscheme][18](I am the author)
- etc...

### Centos Installation
Expand All @@ -55,7 +56,7 @@ and some plugins below:
cd ./vimplus
sudo ./install.sh

Run the `install.sh` script will automatically install and configure vim, installation takes about 40 minutes, mainly download compiler [Valloric/YouCompleteMe][18] time-consuming, please wait until the installation is complete :smile:,**if the installation fails**, please see [Warning](#Warning).
Run the `install.sh` script will automatically install and configure vim, installation takes about 40 minutes, mainly download compiler [Valloric/YouCompleteMe][19] time-consuming, please wait until the installation is complete :smile:,**if the installation fails**, please see [Warning](#Warning).

The installation script will automatically install some software below:
- vim
Expand All @@ -67,31 +68,31 @@ The installation script will automatically install some software below:

and some plugins below:

- [Vundle][19]
- [YouCompleteMe][20]
- [NerdTree][21]
- [nerdcommenter][22]
- [Airline][23]
- [auto-pairs][24]
- [DoxygenToolkit][25]
- [ctrlp][26]
- [tagbar][27]
- [vim-devicons][28]
- [vim-surround][29]
- [vim-commentary][30]
- [tabular][31]
- [vim-dirdiff][32]
- [vim-coloresque][33]
- [change-colorscheme][34](I am the author)
- [Vundle][20]
- [YouCompleteMe][21]
- [NerdTree][22]
- [nerdcommenter][23]
- [Airline][24]
- [auto-pairs][25]
- [DoxygenToolkit][26]
- [ctrlp][27]
- [tagbar][28]
- [vim-devicons][29]
- [vim-surround][30]
- [vim-commentary][31]
- [tabular][32]
- [vim-dirdiff][33]
- [vim-coloresque][34]
- [change-colorscheme][35](I am the author)
- etc...

Configuration ycm
------------
Run the `install.sh` script after the installation is complete, `HOME` directory will exist [.ycm_extra_conf.py][35] and `.vimrc`, the file is YCM implement C++ and other languages syntax completion function profile, I would put a general in the `HOME` directory, then copy `each project` a [.ycm_extra_conf.py][36],**don't** just copy/paste that file somewhere and expect things to magically work; **your project needs different flags**. Hint: just replace the strings in the `flags` variable with compilation flags necessary for your project. That should be enough for 99% of projects.
Run the `install.sh` script after the installation is complete, `HOME` directory will exist [.ycm_extra_conf.py][36] and `.vimrc`, the file is YCM implement C++ and other languages syntax completion function profile, I would put a general in the `HOME` directory, then copy `each project` a [.ycm_extra_conf.py][37],**don't** just copy/paste that file somewhere and expect things to magically work; **your project needs different flags**. Hint: just replace the strings in the `flags` variable with compilation flags necessary for your project. That should be enough for 99% of projects.

Note
------------
1. In order to use [vim-devicons][37], you have to set font, if you don't have guifont set and are not running gvim you will need to set the terminal font(you have to set this font:`Droid Sans Mono for Powerline Nerd Font Complete`).
1. In order to use [vim-devicons][38], you have to set font, if you don't have guifont set and are not running gvim you will need to set the terminal font(you have to set this font:`Droid Sans Mono for Powerline Nerd Font Complete`).

Shortcuts
------------
Expand All @@ -114,102 +115,103 @@ Features
------------
### Syntax completion

[YouCompleteMe][38] plugin provides syntax completion function, and YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim.
![此处输入图片的描述][39]
[YouCompleteMe][39] plugin provides syntax completion function, and YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim.
![此处输入图片的描述][40]

### Full path fuzzy file, buffer, mru, tag
[ctrlp][40] plugin provides full path fuzzy file, buffer, mru, tag, ... finder for Vim.
![此处输入图片的描述][41]
[ctrlp][41] plugin provides full path fuzzy file, buffer, mru, tag, ... finder for Vim.
![此处输入图片的描述][42]

### vim-airline
Lean & mean status/tabline for vim that's light as air.
![此处输入图片的描述][42]
![此处输入图片的描述][43]

### vim-surround
Surround a vim text object with a pair of symmetrical chars. We can also remove or change the ones already there.
![此处输入图片的描述][43]
![此处输入图片的描述][44]

### vim-commentary
An extremely easy tool to toggle commentary in lines and visual selections. We only need to enter a mapping and a movement to do the action, as simple as that.
![此处输入图片的描述][44]
![此处输入图片的描述][45]

### auto-pairs
auto-pairs provides smart auto-completion for delimiters like (), {}, [], "", '', ``.
![此处输入图片的描述][45]
![此处输入图片的描述][46]

### vim-devicons
![此处输入图片的描述][46]
![此处输入图片的描述][47]
![此处输入图片的描述][48]
![此处输入图片的描述][49]

### vim-coloresque
![此处输入图片的描述][49]
![此处输入图片的描述][50]

### vim-dirdiff
![此处输入图片的描述][50]
![此处输入图片的描述][51]

### Change the colorscheme
[change-colorscheme][51] plugin provides quick change theme function.
![此处输入图片的描述][52]
[change-colorscheme][52] plugin provides quick change theme function.
![此处输入图片的描述][53]

### <span id="Warning">**Warning**</span>
------------
1. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][53] installation fails, after a failed installation will need to `rm -rf ~/.vim/bundle/YouCompleteMe`, and then re-execute the `install.sh` can be re-installed, the program will automatically install the plug-in installation fails,**or I have** [YouCompleteMe.tar.gz][54],download it and then `tar -xvf YouCompleteMe.tar.gz -C ~/.vim/bundle/`,then `cd ~/.vim/bundle/YouCompleteMe` and run `python ./install.py --clang-completer`.
2. In `ubuntu16.04LTS` installation may fail([Valloric/YouCompleteMe][55] installation fails), **because vim default support for plug python3 compiled**, after a failed installation, manually `cd ~/.vim/bundle/YouCompleteMe`, then run `python3 ./install.py --clang-completer`.


[1]: https://github.com/Valloric/YouCompleteMe
[2]: https://github.com/VundleVim/Vundle.vim
[3]: https://github.com/Valloric/YouCompleteMe
[4]: https://github.com/scrooloose/nerdtree
[5]: https://github.com/scrooloose/nerdcommenter
[6]: https://github.com/vim-airline/vim-airline
[7]: https://github.com/jiangmiao/auto-pairs
[8]: https://github.com/vim-scripts/DoxygenToolkit.vim
[9]: https://github.com/ctrlpvim/ctrlp.vim
[10]: https://github.com/majutsushi/tagbar
[11]: https://github.com/ryanoasis/vim-devicons
[12]: https://github.com/tpope/vim-surround
[13]: https://github.com/tpope/vim-commentary
[14]: https://github.com/godlygeek/tabular
[15]: https://github.com/will133/vim-dirdiff
[16]: https://github.com/gorodinskiy/vim-coloresque
[17]: https://github.com/chxuan/change-colorscheme
[18]: https://github.com/Valloric/YouCompleteMe
[19]: https://github.com/VundleVim/Vundle.vim
[20]: https://github.com/Valloric/YouCompleteMe
[21]: https://github.com/scrooloose/nerdtree
[22]: https://github.com/scrooloose/nerdcommenter
[23]: https://github.com/vim-airline/vim-airline
[24]: https://github.com/jiangmiao/auto-pairs
[25]: https://github.com/vim-scripts/DoxygenToolkit.vim
[26]: https://github.com/ctrlpvim/ctrlp.vim
[27]: https://github.com/majutsushi/tagbar
[28]: https://github.com/ryanoasis/vim-devicons
[29]: https://github.com/tpope/vim-surround
[30]: https://github.com/tpope/vim-commentary
[31]: https://github.com/godlygeek/tabular
[32]: https://github.com/will133/vim-dirdiff
[33]: https://github.com/gorodinskiy/vim-coloresque
[34]: https://github.com/chxuan/change-colorscheme
[35]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
1. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][54] installation fails, after a failed installation will need to `rm -rf ~/.vim/bundle/YouCompleteMe`, and then re-execute the `install.sh` can be re-installed, the program will automatically install the plug-in installation fails,**or I have** [YouCompleteMe.tar.gz][55],download it and then `tar -xvf YouCompleteMe.tar.gz -C ~/.vim/bundle/`,then `cd ~/.vim/bundle/YouCompleteMe` and run `python ./install.py --clang-completer`.
2. In `ubuntu16.04LTS` installation may fail([Valloric/YouCompleteMe][56] installation fails), **because vim default support for plug python3 compiled**, after a failed installation, manually `cd ~/.vim/bundle/YouCompleteMe`, then run `python3 ./install.py --clang-completer`.


[1]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/vimplus.png
[2]: https://github.com/Valloric/YouCompleteMe
[3]: https://github.com/VundleVim/Vundle.vim
[4]: https://github.com/Valloric/YouCompleteMe
[5]: https://github.com/scrooloose/nerdtree
[6]: https://github.com/scrooloose/nerdcommenter
[7]: https://github.com/vim-airline/vim-airline
[8]: https://github.com/jiangmiao/auto-pairs
[9]: https://github.com/vim-scripts/DoxygenToolkit.vim
[10]: https://github.com/ctrlpvim/ctrlp.vim
[11]: https://github.com/majutsushi/tagbar
[12]: https://github.com/ryanoasis/vim-devicons
[13]: https://github.com/tpope/vim-surround
[14]: https://github.com/tpope/vim-commentary
[15]: https://github.com/godlygeek/tabular
[16]: https://github.com/will133/vim-dirdiff
[17]: https://github.com/gorodinskiy/vim-coloresque
[18]: https://github.com/chxuan/change-colorscheme
[19]: https://github.com/Valloric/YouCompleteMe
[20]: https://github.com/VundleVim/Vundle.vim
[21]: https://github.com/Valloric/YouCompleteMe
[22]: https://github.com/scrooloose/nerdtree
[23]: https://github.com/scrooloose/nerdcommenter
[24]: https://github.com/vim-airline/vim-airline
[25]: https://github.com/jiangmiao/auto-pairs
[26]: https://github.com/vim-scripts/DoxygenToolkit.vim
[27]: https://github.com/ctrlpvim/ctrlp.vim
[28]: https://github.com/majutsushi/tagbar
[29]: https://github.com/ryanoasis/vim-devicons
[30]: https://github.com/tpope/vim-surround
[31]: https://github.com/tpope/vim-commentary
[32]: https://github.com/godlygeek/tabular
[33]: https://github.com/will133/vim-dirdiff
[34]: https://github.com/gorodinskiy/vim-coloresque
[35]: https://github.com/chxuan/change-colorscheme
[36]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[37]: https://github.com/ryanoasis/vim-devicons
[38]: https://github.com/VundleVim/Vundle.vim
[39]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966
[40]: https://github.com/ctrlpvim/ctrlp.vim
[41]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67
[42]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966
[43]: https://camo.githubusercontent.com/1f02cead8bdcf894f26b0006c44068a33a7dc8e5/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f737572726f756e645f656e2e676966
[44]: https://camo.githubusercontent.com/2f5cb5bc9a964b0d9e623b5b3aff0314294ac841/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f636f6d6d656e746172795f656e2e676966
[45]: https://camo.githubusercontent.com/372b34413e710cdbc95c5a5c1f901baf9e77791d/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f736d617274696e7075745f656e2e676966
[46]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png
[47]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png
[48]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png
[49]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67
[50]: https://raw.githubusercontent.com/will133/vim-dirdiff/master/screenshot.png
[51]: https://github.com/chxuan/change-colorscheme
[52]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif
[53]: https://github.com/Valloric/YouCompleteMe
[54]: http://pan.baidu.com/s/1kUIa1kN
[55]: https://github.com/Valloric/YouCompleteMe
[37]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[38]: https://github.com/ryanoasis/vim-devicons
[39]: https://github.com/VundleVim/Vundle.vim
[40]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966
[41]: https://github.com/ctrlpvim/ctrlp.vim
[42]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67
[43]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966
[44]: https://camo.githubusercontent.com/1f02cead8bdcf894f26b0006c44068a33a7dc8e5/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f737572726f756e645f656e2e676966
[45]: https://camo.githubusercontent.com/2f5cb5bc9a964b0d9e623b5b3aff0314294ac841/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f636f6d6d656e746172795f656e2e676966
[46]: https://camo.githubusercontent.com/372b34413e710cdbc95c5a5c1f901baf9e77791d/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f736d617274696e7075745f656e2e676966
[47]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png
[48]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png
[49]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png
[50]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67
[51]: https://raw.githubusercontent.com/will133/vim-dirdiff/master/screenshot.png
[52]: https://github.com/chxuan/change-colorscheme
[53]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif
[54]: https://github.com/Valloric/YouCompleteMe
[55]: http://pan.baidu.com/s/1kUIa1kN
[56]: https://github.com/Valloric/YouCompleteMe

0 comments on commit 821727a

Please sign in to comment.