diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 127 |
1 files changed, 100 insertions, 27 deletions
@@ -1,72 +1,125 @@ # Base16 Vim -See the [Base16 repository](https://github.com/chriskempson/base16) for more information. -This theme was built with [Base16 Builder PHP](https://github.com/chriskempson/base16-builder-php). + +Supports console [Vim][1], graphical Vim and [Neovim][2]. Supports graphical Vim and console Vim. - +Over [200 themes][3] plus light/dark variations are available. Here are +some of our favorites: + +The `classic-dark` theme: + +![base16-vim classic-dark][10] + +The `horizon-dark` theme: + +![base16-vim horizon-dark][11] + +The `onedark` theme: + +![base16-vim onedark][12] ## Terminal Themes -For terminal Vim (non-gui) please ensure you are using a base16 terminal theme. -* [iTerm2](https://github.com/chriskempson/base16-iterm2) +For terminal Vim (non-gui) please ensure you are using a base16 terminal +theme. Have a look at the list of [official][4] and [unofficial][5] +themes for your terminal of choice. ## Installation Add `colorscheme base16-default-dark` to your `~/.vimrc`. ### Vundle + Add the following to your `~/.vimrc` file and run `PluginInstall` in Vim. - Plugin 'chriskempson/base16-vim' +```vim +Plugin 'base16-project/base16-vim' +``` ### vim-plug + Add the following to your `~/.vimrc` file and run `PlugInstall` in Vim. - Plug 'chriskempson/base16-vim' +```vim +Plug 'base16-project/base16-vim' +``` ### Pathogen - cd ~/.vim/bundle - git clone https://github.com/chriskempson/base16-vim.git +```bash +cd ~/.vim/bundle +git clone https://github.com/base16-project/base16-vim.git +``` ### Manual - cd ~/.vim/colors - git clone git://github.com/chriskempson/base16-vim.git base16 - cp base16/colors/*.vim . - -## 256 colorspace -If using a Base16 terminal theme designed to keep the 16 ANSI colors intact (a "256" variation) **and** have sucessfully modified your 256 colorspace with [base16-shell](https://github.com/chriskempson/base16-shell) you'll need to add the following to your `~/.vimrc` **before** the colorsheme declaration. +```bash +cd ~/.vim/colors +git clone git://github.com/base16-project/base16-vim.git base16 +cp base16/colors/*.vim . +``` + +### Manual neovim + +```bash +cd ~/.config/nvim/colors +git clone git://github.com/base16-project/base16-vim.git base16 +cp base16/colors/*.vim . +``` - let base16colorspace=256 " Access colors present in 256 colorspace +## 256 colorspace -This will cause vim to access the colours in the modified 256 colorspace. Please **do not** enable this simply because you have a 256 color terminal as this will cause colors to be displayed incorrectly. +If using a Base16 terminal theme designed to keep the 16 ANSI colors +intact (a "256" variation) **and** have sucessfully modified your 256 +colorspace with [base16-shell][6] you'll need to add the following to +your `~/.vimrc` **before** the colorsheme declaration. + +```vim +let base16colorspace=256 " Access colors present in 256 colorspace +``` + +This will cause vim to access the colours in the modified 256 +colorspace. Please **do not** enable this simply because you have a 256 +color terminal as this will cause colors to be displayed incorrectly. ## Troubleshooting -There is a script to help troubleshoot colour issues called `colortest` available in the [Base16 Shell](https://github.com/chriskempson/base16-shell) repository. -If you are using a ISO-8613-3 compatible terminal ( -[vim docs](https://github.com/vim/vim/blob/23c1b2b018c8121ca5fcc247e37966428bf8ca66/runtime/doc/options.txt#L7876), -[neovim docs](https://neovim.io/doc/user/options.html#'termguicolors')), and -you see a green or blue line, try to enable `termguicolors`: +There is a script to help troubleshoot colour issues called `colortest` +available in the [Base16 Shell][6] repository. + +If you are using a ISO-8613-3 compatible terminal ([vim docs][7], +[neovim docs][8]), and you see a green or blue line, try to enable +`termguicolors`: ```vim set termguicolors ``` ### Green line numbers - -If your Vim looks like the above image you are using a 256 terminal theme without setting `let base16colorspace=256` in your `~/.vimrc`. Either set `let base16colorspace=256` in your `~/.vimrc` or use a non 256 terminal theme. +![green line numbers screenshot][13] + +If your Vim looks like the above image you are using a 256 terminal +theme without setting `let base16colorspace=256` in your `~/.vimrc`. +Either set `let base16colorspace=256` in your `~/.vimrc` or use a non +256 terminal theme. ### Blue line numbers - -If your Vim looks like the above image you are setting `let base16colorspace=256` in your `~/.vimrc` but either not running [Base16 Shell](https://github.com/chriskempson/base16-shell) or [Base16 Shell](https://github.com/chriskempson/base16-shell) is not working for your terminal. Either ensure [Base16 Shell](https://github.com/chriskempson/base16-shell) is working by running the `colortest` available in the [Base16 Shell](https://github.com/chriskempson/base16-shell) repository or not setting `let base16colorspace=256` in your `~/.vimrc`. +![blue line numbers screenshot][14] + +If your Vim looks like the above image you are setting `let +base16colorspace=256` in your `~/.vimrc` but either not running [Base16 +Shell][6] or [Base16 Shell][6] is not working for your terminal. Either +ensure [Base16 Shell][6] is working by running the `colortest` available +in the [Base16 Shell][6] repository or not setting `let +base16colorspace=256` in your `~/.vimrc`. ## Customization -If you want to do some local customization, you can add something like this to your `~/.vimrc`: + +If you want to do some local customization, you can add something like +this to your `~/.vimrc`: ```vim function! s:base16_customize() abort @@ -78,3 +131,23 @@ augroup on_change_colorschema autocmd ColorScheme * call s:base16_customize() augroup END ``` + +## Contributing + +See [`CONTRIBUTING.md`][9], which contains building and contributing +instructions. + +[1]: https://github.com/vim/vim +[2]: https://github.com/neovim/neovim +[3]: https://github.com/base16-project/base16-schemes +[4]: https://github.com/base16-project/base16#official-templates +[5]: https://github.com/base16-project/base16#unofficial-templates +[6]: https://github.com/base16-project/base16-shell +[7]: https://github.com/vim/vim/blob/23c1b2b018c8121ca5fcc247e37966428bf8ca66/runtime/doc/options.txt#L7876 +[8]: https://neovim.io/doc/user/options.html#'termguicolors' +[9]: CONTRIBUTING.md +[10]: screenshots/base16-vim-screenshot-classic-dark.png +[11]: screenshots/base16-vim-screenshot-horizon-dark.png +[12]: screenshots/base16-vim-screenshot-onedark.png +[13]: screenshots/without-base16colorspace-256-with-256-terminal-theme.png +[14]: screenshots/with-base16colorspace-256-without-base16-shell.png |