Update README.md

This commit is contained in:
chxuan 2016-06-25 08:41:18 +08:00 committed by GitHub
parent 635b1f436b
commit f0a860101a

168
README.md
View File

@ -50,7 +50,8 @@ and some plugins below:
- [tabular][17] - [tabular][17]
- [vim-dirdiff][18] - [vim-dirdiff][18]
- [vim-coloresque][19] - [vim-coloresque][19]
- [change-colorscheme][20](I am the author) - [incsearch.vim][20]
- [change-colorscheme][21](I am the author)
- etc... - etc...
### Centos Installation ### Centos Installation
@ -61,7 +62,7 @@ cd ./vimplus
sudo ./install.sh sudo ./install.sh
``` ```
Run the `install.sh` script will automatically install and configure vim, installation takes about 40 minutes, mainly download compiler [Valloric/YouCompleteMe][21] 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][22] 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: The installation script will automatically install some software below:
- vim - vim
@ -73,33 +74,34 @@ The installation script will automatically install some software below:
and some plugins below: and some plugins below:
- [Vundle][22] - [Vundle][23]
- [YouCompleteMe][23] - [YouCompleteMe][24]
- [NerdTree][24] - [NerdTree][25]
- [nerdcommenter][25] - [nerdcommenter][26]
- [Airline][26] - [Airline][27]
- [auto-pairs][27] - [auto-pairs][28]
- [DoxygenToolkit][28] - [DoxygenToolkit][29]
- [ctrlp][29] - [ctrlp][30]
- [tagbar][30] - [tagbar][31]
- [vim-devicons][31] - [vim-devicons][32]
- [vim-surround][32] - [vim-surround][33]
- [vim-commentary][33] - [vim-commentary][34]
- [vim-repeat][34] - [vim-repeat][35]
- [vim-endwise][35] - [vim-endwise][36]
- [tabular][36] - [tabular][37]
- [vim-dirdiff][37] - [vim-dirdiff][38]
- [vim-coloresque][38] - [vim-coloresque][39]
- [change-colorscheme][39](I am the author) - [incsearch.vim][40]
- [change-colorscheme][41](I am the author)
- etc... - etc...
Configuration ycm Configuration ycm
------------ ------------
Run the `install.sh` script after the installation is complete, `HOME` directory will exist [.ycm_extra_conf.py][40] 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][41],**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][42] 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][43],**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 Note
------------ ------------
1. In order to use [vim-devicons][42], 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][44], 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 Shortcuts
------------ ------------
@ -123,48 +125,51 @@ Features
------------ ------------
### Syntax completion ### Syntax completion
[YouCompleteMe][43] plugin provides syntax completion function, and YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim. [YouCompleteMe][45] plugin provides syntax completion function, and YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for Vim.
![此处输入图片的描述][44] ![此处输入图片的描述][46]
### Full path fuzzy file, buffer, mru, tag ### Full path fuzzy file, buffer, mru, tag
[ctrlp][45] plugin provides full path fuzzy file, buffer, mru, tag, ... finder for Vim. [ctrlp][47] plugin provides full path fuzzy file, buffer, mru, tag, ... finder for Vim.
![此处输入图片的描述][46] ![此处输入图片的描述][48]
### vim-airline ### vim-airline
Lean & mean status/tabline for vim that's light as air. Lean & mean status/tabline for vim that's light as air.
![此处输入图片的描述][47] ![此处输入图片的描述][49]
### vim-surround ### vim-surround
Surround a vim text object with a pair of symmetrical chars. We can also remove or change the ones already there. Surround a vim text object with a pair of symmetrical chars. We can also remove or change the ones already there.
![此处输入图片的描述][48] ![此处输入图片的描述][50]
### vim-commentary ### 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. 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.
![此处输入图片的描述][49] ![此处输入图片的描述][51]
### auto-pairs ### auto-pairs
auto-pairs provides smart auto-completion for delimiters like (), {}, [], "", '', ``. auto-pairs provides smart auto-completion for delimiters like (), {}, [], "", '', ``.
![此处输入图片的描述][50]
### vim-devicons
![此处输入图片的描述][51]
![此处输入图片的描述][52] ![此处输入图片的描述][52]
### incsearch.vim
![此处输入图片的描述][53] ![此处输入图片的描述][53]
### vim-coloresque ### vim-devicons
![此处输入图片的描述][54] ![此处输入图片的描述][54]
![此处输入图片的描述][55]
![此处输入图片的描述][56]
### vim-coloresque
![此处输入图片的描述][57]
### vim-dirdiff ### vim-dirdiff
![此处输入图片的描述][55] ![此处输入图片的描述][58]
### Change the colorscheme ### Change the colorscheme
[change-colorscheme][56] plugin provides quick change theme function. [change-colorscheme][59] plugin provides quick change theme function.
![此处输入图片的描述][57] ![此处输入图片的描述][60]
### <span id="Warning">**Warning**</span> ### <span id="Warning">**Warning**</span>
------------ ------------
1. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][58] 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][59],download it and then `tar -xvf YouCompleteMe.tar.gz -C ~/.vim/bundle/`,then `cd ~/.vim/bundle/YouCompleteMe` and run `python ./install.py --clang-completer`. 1. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][61] 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][62],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][60] 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`. 2. In `ubuntu16.04LTS` installation may fail([Valloric/YouCompleteMe][63] 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 [1]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/vimplus.png
@ -186,44 +191,47 @@ auto-pairs provides smart auto-completion for delimiters like (), {}, [], "", ''
[17]: https://github.com/godlygeek/tabular [17]: https://github.com/godlygeek/tabular
[18]: https://github.com/will133/vim-dirdiff [18]: https://github.com/will133/vim-dirdiff
[19]: https://github.com/gorodinskiy/vim-coloresque [19]: https://github.com/gorodinskiy/vim-coloresque
[20]: https://github.com/chxuan/change-colorscheme [20]: https://github.com/haya14busa/incsearch.vim
[21]: https://github.com/Valloric/YouCompleteMe [21]: https://github.com/chxuan/change-colorscheme
[22]: https://github.com/VundleVim/Vundle.vim [22]: https://github.com/Valloric/YouCompleteMe
[23]: https://github.com/Valloric/YouCompleteMe [23]: https://github.com/VundleVim/Vundle.vim
[24]: https://github.com/scrooloose/nerdtree [24]: https://github.com/Valloric/YouCompleteMe
[25]: https://github.com/scrooloose/nerdcommenter [25]: https://github.com/scrooloose/nerdtree
[26]: https://github.com/vim-airline/vim-airline [26]: https://github.com/scrooloose/nerdcommenter
[27]: https://github.com/jiangmiao/auto-pairs [27]: https://github.com/vim-airline/vim-airline
[28]: https://github.com/vim-scripts/DoxygenToolkit.vim [28]: https://github.com/jiangmiao/auto-pairs
[29]: https://github.com/ctrlpvim/ctrlp.vim [29]: https://github.com/vim-scripts/DoxygenToolkit.vim
[30]: https://github.com/majutsushi/tagbar [30]: https://github.com/ctrlpvim/ctrlp.vim
[31]: https://github.com/ryanoasis/vim-devicons [31]: https://github.com/majutsushi/tagbar
[32]: https://github.com/tpope/vim-surround [32]: https://github.com/ryanoasis/vim-devicons
[33]: https://github.com/tpope/vim-commentary [33]: https://github.com/tpope/vim-surround
[34]: https://github.com/tpope/vim-repeat [34]: https://github.com/tpope/vim-commentary
[35]: https://github.com/tpope/vim-endwise [35]: https://github.com/tpope/vim-repeat
[36]: https://github.com/godlygeek/tabular [36]: https://github.com/tpope/vim-endwise
[37]: https://github.com/will133/vim-dirdiff [37]: https://github.com/godlygeek/tabular
[38]: https://github.com/gorodinskiy/vim-coloresque [38]: https://github.com/will133/vim-dirdiff
[39]: https://github.com/chxuan/change-colorscheme [39]: https://github.com/gorodinskiy/vim-coloresque
[40]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py [40]: https://github.com/haya14busa/incsearch.vim
[41]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py [41]: https://github.com/chxuan/change-colorscheme
[42]: https://github.com/ryanoasis/vim-devicons [42]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[43]: https://github.com/VundleVim/Vundle.vim [43]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[44]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966 [44]: https://github.com/ryanoasis/vim-devicons
[45]: https://github.com/ctrlpvim/ctrlp.vim [45]: https://github.com/VundleVim/Vundle.vim
[46]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67 [46]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966
[47]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966 [47]: https://github.com/ctrlpvim/ctrlp.vim
[48]: https://camo.githubusercontent.com/1f02cead8bdcf894f26b0006c44068a33a7dc8e5/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f737572726f756e645f656e2e676966 [48]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67
[49]: https://camo.githubusercontent.com/2f5cb5bc9a964b0d9e623b5b3aff0314294ac841/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f636f6d6d656e746172795f656e2e676966 [49]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966
[50]: https://camo.githubusercontent.com/372b34413e710cdbc95c5a5c1f901baf9e77791d/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f736d617274696e7075745f656e2e676966 [50]: https://camo.githubusercontent.com/1f02cead8bdcf894f26b0006c44068a33a7dc8e5/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f737572726f756e645f656e2e676966
[51]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png [51]: https://camo.githubusercontent.com/2f5cb5bc9a964b0d9e623b5b3aff0314294ac841/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f636f6d6d656e746172795f656e2e676966
[52]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png [52]: https://camo.githubusercontent.com/372b34413e710cdbc95c5a5c1f901baf9e77791d/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f736d617274696e7075745f656e2e676966
[53]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png [53]: https://raw.githubusercontent.com/haya14busa/i/master/incsearch.vim/incremental_regex_building.gif
[54]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67 [54]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png
[55]: https://raw.githubusercontent.com/will133/vim-dirdiff/master/screenshot.png [55]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png
[56]: https://github.com/chxuan/change-colorscheme [56]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png
[57]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif [57]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67
[58]: https://github.com/Valloric/YouCompleteMe [58]: https://raw.githubusercontent.com/will133/vim-dirdiff/master/screenshot.png
[59]: http://pan.baidu.com/s/1kUIa1kN [59]: https://github.com/chxuan/change-colorscheme
[60]: https://github.com/Valloric/YouCompleteMe [60]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif
[61]: https://github.com/Valloric/YouCompleteMe
[62]: http://pan.baidu.com/s/1kUIa1kN
[63]: https://github.com/Valloric/YouCompleteMe