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 9d1e5a6 commit 71c0600
Showing 1 changed file with 88 additions and 67 deletions.
155 changes: 88 additions & 67 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ and some plugins below:
- [tagbar][10]
- [vim-devicons][11]
- [vim-surround][12]
- [tabular][13]
- [vim-coloresque][14]
- [change-colorscheme][15](I am the author)
- [vim-commentary][13]
- [tabular][14]
- [vim-coloresque][15]
- [change-colorscheme][16](I am the author)
- etc...

### Centos Installation
Expand All @@ -53,7 +54,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][16] time-consuming, please wait until the installation is complete ^ _ ^,**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][17] time-consuming, please wait until the installation is complete ^ _ ^,**if the installation fails**, please see [Warning](#Warning).

The installation script will automatically install some software below:
- vim
Expand All @@ -65,29 +66,30 @@ The installation script will automatically install some software below:

and some plugins below:

- [Vundle][17]
- [YouCompleteMe][18]
- [NerdTree][19]
- [nerdcommenter][20]
- [Airline][21]
- [auto-pairs][22]
- [DoxygenToolkit][23]
- [ctrlp][24]
- [tagbar][25]
- [vim-devicons][26]
- [vim-surround][27]
- [tabular][28]
- [vim-coloresque][29]
- [change-colorscheme][30](I am the author)
- [Vundle][18]
- [YouCompleteMe][19]
- [NerdTree][20]
- [nerdcommenter][21]
- [Airline][22]
- [auto-pairs][23]
- [DoxygenToolkit][24]
- [ctrlp][25]
- [tagbar][26]
- [vim-devicons][27]
- [vim-surround][28]
- [vim-commentary][29]
- [tabular][30]
- [vim-coloresque][31]
- [change-colorscheme][32](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][31] 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][32],**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][33] 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][34],**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][33], 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][35], 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 @@ -101,39 +103,53 @@ Shortcuts
- Buffer switch `<Ctrl + P/Ctrl + N>`
- Cursor position switch `<Ctrl + O/Ctrl + I>`
- Fuzzy Find File `<Ctrl + f>`
- Surround `<ys{motion or text-object}{char}/cs{orig_char}{dest_char}/ds{char}>`
- Comment code `<gcc/gcap/gc>`
- Change the colorscheme `<F10/F9>`

Features
------------
### Syntax completion

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

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

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

### vim-devicons
![此处输入图片的描述][40]

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

### 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.
![此处输入图片的描述][42]

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

### vim-devicons
![此处输入图片的描述][44]
![此处输入图片的描述][45]
![此处输入图片的描述][46]

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

### Change the colorscheme
[change-colorscheme][43] plugin provides quick change theme function.
![此处输入图片的描述][44]
[change-colorscheme][48] plugin provides quick change theme function.
![此处输入图片的描述][49]

### <span id="Warning">**Warning**</span>
------------
1. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][45] 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][46],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][47] 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. If poor network conditions may fail to install, basically [Valloric/YouCompleteMe][50] 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][51],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][52] 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
Expand All @@ -148,38 +164,43 @@ Lean & mean status/tabline for vim that's light as air.
[10]: https://github.com/majutsushi/tagbar
[11]: https://github.com/ryanoasis/vim-devicons
[12]: https://github.com/tpope/vim-surround
[13]: https://github.com/godlygeek/tabular
[14]: https://github.com/gorodinskiy/vim-coloresque
[15]: https://github.com/chxuan/change-colorscheme
[16]: https://github.com/Valloric/YouCompleteMe
[17]: https://github.com/VundleVim/Vundle.vim
[18]: https://github.com/Valloric/YouCompleteMe
[19]: https://github.com/scrooloose/nerdtree
[20]: https://github.com/scrooloose/nerdcommenter
[21]: https://github.com/vim-airline/vim-airline
[22]: https://github.com/jiangmiao/auto-pairs
[23]: https://github.com/vim-scripts/DoxygenToolkit.vim
[24]: https://github.com/ctrlpvim/ctrlp.vim
[25]: https://github.com/majutsushi/tagbar
[26]: https://github.com/ryanoasis/vim-devicons
[27]: https://github.com/tpope/vim-surround
[28]: https://github.com/godlygeek/tabular
[29]: https://github.com/gorodinskiy/vim-coloresque
[30]: https://github.com/chxuan/change-colorscheme
[31]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[32]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[33]: https://github.com/ryanoasis/vim-devicons
[34]: https://github.com/VundleVim/Vundle.vim
[35]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966
[36]: https://github.com/ctrlpvim/ctrlp.vim
[37]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67
[38]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966
[39]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67
[40]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png
[41]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png
[42]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png
[43]: https://github.com/chxuan/change-colorscheme
[44]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif
[45]: https://github.com/Valloric/YouCompleteMe
[46]: http://pan.baidu.com/s/1kUIa1kN
[47]: https://github.com/Valloric/YouCompleteMe
[13]: https://github.com/tpope/vim-commentary
[14]: https://github.com/godlygeek/tabular
[15]: https://github.com/gorodinskiy/vim-coloresque
[16]: https://github.com/chxuan/change-colorscheme
[17]: https://github.com/Valloric/YouCompleteMe
[18]: https://github.com/VundleVim/Vundle.vim
[19]: https://github.com/Valloric/YouCompleteMe
[20]: https://github.com/scrooloose/nerdtree
[21]: https://github.com/scrooloose/nerdcommenter
[22]: https://github.com/vim-airline/vim-airline
[23]: https://github.com/jiangmiao/auto-pairs
[24]: https://github.com/vim-scripts/DoxygenToolkit.vim
[25]: https://github.com/ctrlpvim/ctrlp.vim
[26]: https://github.com/majutsushi/tagbar
[27]: https://github.com/ryanoasis/vim-devicons
[28]: https://github.com/tpope/vim-surround
[29]: https://github.com/tpope/vim-commentary
[30]: https://github.com/godlygeek/tabular
[31]: https://github.com/gorodinskiy/vim-coloresque
[32]: https://github.com/chxuan/change-colorscheme
[33]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[34]: https://github.com/chxuan/vimplus/blob/master/.ycm_extra_conf.py
[35]: https://github.com/ryanoasis/vim-devicons
[36]: https://github.com/VundleVim/Vundle.vim
[37]: https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966
[38]: https://github.com/ctrlpvim/ctrlp.vim
[39]: https://camo.githubusercontent.com/e15ac916ab9a14dd07135cb2d985cc7333200a38/687474703a2f2f692e696d6775722e636f6d2f614f63774877742e706e67
[40]: https://camo.githubusercontent.com/ba79534309330accd776a8d2a0712f7c4037d7f9/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3330363530322f313037323632332f34346332393261302d313439352d313165332d396365362d6463616461336631633533362e676966
[41]: https://camo.githubusercontent.com/1f02cead8bdcf894f26b0006c44068a33a7dc8e5/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f737572726f756e645f656e2e676966
[42]: https://camo.githubusercontent.com/2f5cb5bc9a964b0d9e623b5b3aff0314294ac841/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f636f6d6d656e746172795f656e2e676966
[43]: https://camo.githubusercontent.com/372b34413e710cdbc95c5a5c1f901baf9e77791d/687474703a2f2f6a6f65646963617374726f2e636f6d2f7374617469632f70696374757265732f736d617274696e7075745f656e2e676966
[44]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-1.png
[45]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-2.png
[46]: https://raw.githubusercontent.com/wiki/ryanoasis/vim-devicons/screenshots/v0.8.x/nerdtree-3.png
[47]: https://camo.githubusercontent.com/70916a51f45b5729332803c5de303f6f1849fc50/68747470733a2f2f7261772e6769746875622e636f6d2f676f726f64696e736b69792f76696d2d636f6c6f7265737175652f6d61737465722f73637265656e2e706e67
[48]: https://github.com/chxuan/change-colorscheme
[49]: https://raw.githubusercontent.com/chxuan/vimplus/master/screenshots/change-colorscheme.gif
[50]: https://github.com/Valloric/YouCompleteMe
[51]: http://pan.baidu.com/s/1kUIa1kN
[52]: https://github.com/Valloric/YouCompleteMe

0 comments on commit 71c0600

Please sign in to comment.