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

This commit is contained in:
Josh Dick
2017-11-20 10:53:01 -05:00
parent 1552d3e8ec
commit d759413977

View File

@@ -8,6 +8,8 @@ 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.)
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:
_Note: GUI (non-terminal) Vim will always display 24-bit color regardless of the configuration done in this step._
@@ -42,7 +44,7 @@ A dark Vim/Neovim color scheme for the GUI and 16/256/true-color terminals, base
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
syntax on