diff --git a/README.md b/README.md index 6b5755f2..039093e1 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,23 @@ ![VIM](https://dnp4pehkvoo6n.cloudfront.net/43c5af597bd5c1a64eb1829f011c208f/as/Ultimate%20Vimrc.svg) -# The Ultimate vimrc +# Install +## install vim-plug -Over the last 10 years, I have used and tweaked Vim. This configuration is the ultimate vimrc (or at least my version of it). + curl -fLo ~/.vim/autoload/plug.vim --create-dirs \ + https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim + +## install coc.nvim -There are two versions: + git clone --depth=1 https://github.com/yuanyahao333/vimconfig.git ~/.vim_runtime + git checkout myConfig -* **The Basic**: If you want something small just copy [basic.vim](https://github.com/amix/vimrc/blob/master/vimrcs/basic.vim) into your ~/.vimrc and you will have a good basic setup -* **The Awesome**: Includes a ton of useful plugins, color schemes, and configurations +## basic version -I would, of course, recommend using the awesome version. + sh ~/.vim_runtime/install_basic_vimrc.sh +## awesome version - -## How to install the Awesome version? -### Install for your own user only -The awesome version includes a lot of great plugins, configurations and color schemes that make Vim a lot better. To install it simply do following from your terminal: - - git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime sh ~/.vim_runtime/install_awesome_vimrc.sh - -### Install for multiple users -To install for multiple users, the repository needs to be cloned to a location accessible for all the intended users. - - git clone --depth=1 https://github.com/amix/vimrc.git /opt/vim_runtime - sh /opt/vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime user0 user1 user2 - # to install for all users with home directories, note that root will not be included - sh /opt/vim_runtime/install_awesome_parameterized.sh /opt/vim_runtime --all - -Naturally, `/opt/vim_runtime` can be any directory, as long as all the users specified have read access. - -## Fonts +# Fonts I recommend using [IBM Plex Mono font](https://github.com/IBM/plex) (it's an open-source and awesome font that can make your code look beautiful). The Awesome vimrc is already setup to try to use it. @@ -38,16 +26,6 @@ Some other fonts that Awesome will try to use: * [Hack](http://sourcefoundry.org/hack/) * [Source Code Pro](https://adobe-fonts.github.io/source-code-pro/) -## How to install the Basic version? - -The basic version is just one file and no plugins. Just copy [basic.vim](https://github.com/amix/vimrc/blob/master/vimrcs/basic.vim) and paste it into your vimrc. - -The basic version is useful to install on remote servers where you don't need many plugins, and you don't do many edits. - - git clone --depth=1 https://github.com/amix/vimrc.git ~/.vim_runtime - sh ~/.vim_runtime/install_basic_vimrc.sh - - ## How to install on Windows? Use [gitforwindows](http://gitforwindows.org/) to checkout the repository and run the installation instructions above. No special instructions needed ;-) @@ -87,12 +65,12 @@ I recommend reading the docs of these plugins to understand them better. Each pl * [ack.vim](https://github.com/mileszs/ack.vim): Vim plugin for `the_silver_searcher` (ag) or ack -- a wicked fast grep * [bufexplorer.zip](https://github.com/vim-scripts/bufexplorer.zip): Quickly and easily switch between buffers. This plugin can be opened with `` +* [coc.nvim](https://github.com/neoclide/coc.nvim): code complettion * [ctrlp.vim](https://github.com/ctrlpvim/ctrlp.vim): Fuzzy file, buffer, mru and tag finder. It's mapped to `` * [goyo.vim](https://github.com/junegunn/goyo.vim) and [vim-zenroom2](https://github.com/amix/vim-zenroom2): * [lightline.vim](https://github.com/itchyny/lightline.vim): A light and configurable statusline/tabline for Vim * [NERD Tree](https://github.com/preservim/nerdtree): A tree explorer plugin for vim * [open_file_under_cursor.vim](https://github.com/amix/open_file_under_cursor.vim): Open file under cursor when pressing `gf` -* [pathogen.vim](https://github.com/tpope/vim-pathogen): Manage your vim runtimepath * [snipmate.vim](https://github.com/garbas/vim-snipmate): snipmate.vim aims to be a concise vim script that implements some of TextMate's snippets features in Vim * [ale](https://github.com/dense-analysis/ale): Syntax and lint checking for vim (ALE requires NeoVim >= 0.2.0 or Vim 8 with +timers +job +channel) * [vim-commentary](https://github.com/tpope/vim-commentary): Comment stuff out. Use `gcc` to comment out a line (takes a count), `gc` to comment out the target of a motion. `gcu` uncomments a set of adjacent commented lines @@ -100,6 +78,7 @@ I recommend reading the docs of these plugins to understand them better. Each pl * [vim-fugitive](https://github.com/tpope/vim-fugitive): A Git wrapper so awesome, it should be illegal * [vim-indent-object](https://github.com/michaeljsmith/vim-indent-object): Defines a new text object representing lines of code at the same indent level. Useful for python/vim scripts * [vim-multiple-cursors](https://github.com/terryma/vim-multiple-cursors): Sublime Text style multiple selections for Vim, CTRL+N is remapped to CTRL+S (due to YankRing) +* [vim-plug](https://github.com/junegunn/vim-plug): Manage your vim runtimepath * [vim-yankstack](https://github.com/maxbrunsfeld/vim-yankstack): Maintains a history of previous yanks, changes and deletes * [vim-zenroom2](https://github.com/amix/vim-zenroom2) Remove all clutter and focus only on the essential. Similar to iA Writer or Write Room * [gist-vim](https://github.com/mattn/gist-vim) Easily create gists from Vim using the `:Gist` command