m-vim_plugins/onedark.vim
1
0
Fork 0
mirror of https://github.com/joshdick/onedark.vim.git synced 2025-11-08 11:03:49 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

README.md: Fix formatting; add note about installation as a Vim 8 package. Closes #110

Browse Source
This commit is contained in:
Josh Dick
2017-11-20 10:53:01 -05:00
parent 1552d3e8ec
commit d759413977
1 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -8,46 +8,48 @@ A dark Vim/Neovim color scheme for the GUI and 16/256/true-color terminals, base
1. Install the theme using your Vim plug-in manager of choice (or manually, by placing `colors/onedark.vim` in your `~/.vim/colors/` directory and `autoload/onedark.vim` in your `~/.vim/autoload/` directory.) 1. Install the theme using your Vim plug-in manager of choice (or manually, by placing `colors/onedark.vim` in your `~/.vim/colors/` directory and `autoload/onedark.vim` in your `~/.vim/autoload/` directory.)
The theme also supports being installed as a Vim 8 package. Simply clone this repository into `~/.vim/pack/*/opt/` (so that the local path to this README would end up being `~/.vim/pack/*/opt/onedark.vim/README.md`) and add `packadd! onedark.vim` to your `~/.vimrc`. (The `*` in the path can be any value; see `:help packages` for more information.)
2. If you use Vim in a terminal, do the following to test whether your terminal emulator supports [24-bit/"true" color](https://gist.github.com/XVilka/8346728), then add relevant `~/.vimrc` configuration if so: 2. If you use Vim in a terminal, do the following to test whether your terminal emulator supports [24-bit/"true" color](https://gist.github.com/XVilka/8346728), then add relevant `~/.vimrc` configuration if so:
_Note: GUI (non-terminal) Vim will always display 24-bit color regardless of the configuration done in this step._ _Note: GUI (non-terminal) Vim will always display 24-bit color regardless of the configuration done in this step._
Run the following snippet in your shell: Run the following snippet in your shell:
```shell ```shell
printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n" printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
``` ```
If your terminal emulator **does NOT display the word `TRUECOLOR` in red**, it does not support 24-bit color. If you don't want to switch to a different terminal emulator that [supports 24-bit color](https://gist.github.com/XVilka/8346728), **proceed to step 3**. (After installation, the [`g:onedark_termcolors` option](#options) may interest you.) If your terminal emulator **does NOT display the word `TRUECOLOR` in red**, it does not support 24-bit color. If you don't want to switch to a different terminal emulator that [supports 24-bit color](https://gist.github.com/XVilka/8346728), **proceed to step 3**. (After installation, the [`g:onedark_termcolors` option](#options) may interest you.)
If your terminal emulator displays the word `TRUECOLOR` **in red**, it supports 24-bit color, and you should add the following lines to your `~/.vimrc` to enable 24-bit color terminal support inside Vim. If your terminal emulator displays the word `TRUECOLOR` **in red**, it supports 24-bit color, and you should add the following lines to your `~/.vimrc` to enable 24-bit color terminal support inside Vim.
(If you use [tmux](https://tmux.github.io/), be sure to view the tmux-related notes in the first few lines.) (If you use [tmux](https://tmux.github.io/), be sure to view the tmux-related notes in the first few lines.)
```vim ```vim
"Use 24-bit (true-color) mode in Vim/Neovim when outside tmux. "Use 24-bit (true-color) mode in Vim/Neovim when outside tmux.
"If you're using tmux version 2.2 or later, you can remove the outermost $TMUX check and use tmux's 24-bit color support "If you're using tmux version 2.2 or later, you can remove the outermost $TMUX check and use tmux's 24-bit color support
"(see < http://sunaku.github.io/tmux-24bit-color.html#usage > for more information.) "(see < http://sunaku.github.io/tmux-24bit-color.html#usage > for more information.)
if (empty($TMUX)) if (empty($TMUX))
if (has("nvim")) if (has("nvim"))
"For Neovim 0.1.3 and 0.1.4 < https://github.com/neovim/neovim/pull/2198 > "For Neovim 0.1.3 and 0.1.4 < https://github.com/neovim/neovim/pull/2198 >
let $NVIM_TUI_ENABLE_TRUE_COLOR=1 let $NVIM_TUI_ENABLE_TRUE_COLOR=1
endif endif
"For Neovim > 0.1.5 and Vim > patch 7.4.1799 < https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162 > "For Neovim > 0.1.5 and Vim > patch 7.4.1799 < https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162 >
"Based on Vim patch 7.4.1770 (`guicolors` option) < https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd > "Based on Vim patch 7.4.1770 (`guicolors` option) < https://github.com/vim/vim/commit/8a633e3427b47286869aa4b96f2bfc1fe65b25cd >
" < https://github.com/neovim/neovim/wiki/Following-HEAD#20160511 > " < https://github.com/neovim/neovim/wiki/Following-HEAD#20160511 >
if (has("termguicolors")) if (has("termguicolors"))
set termguicolors set termguicolors
endif endif
endif endif
``` ```
3. Add the following to your `~/.vimrc` (below any lines you may have added in step 2): 3. Add the following to your `~/.vimrc` (below any lines you may have added in steps 1 and 2):
```vim ```vim
syntax on syntax on
colorscheme onedark colorscheme onedark
``` ```
4. Installing the [sheerun/vim-polyglot](https://github.com/sheerun/vim-polyglot) plug-in is recommended for improved syntax highlighting for various languages, but is not required. 4. Installing the [sheerun/vim-polyglot](https://github.com/sheerun/vim-polyglot) plug-in is recommended for improved syntax highlighting for various languages, but is not required.