Files
vim-odyssey/README.md
T
Ludovic Koenig 24b738b4e0 Modify the README.md for installation purposes
It is now described how to use 256-colors or 24-bits colors.
2019-03-09 14:02:08 +01:00

50 lines
1.0 KiB
Markdown

# Odyssey for Vim
Odyssey is a dark green colorscheme for Vim.
## Installation
### Downloading the plugin
#### Using `./vim/colors/`
Copy the file `./vim-odyssey/colors/odyssey.vim` under the repertory
`./vim/colors`.
```zsh
git clone https://github.com/ludokng/vim-odyssey.git vim-odyssey/
cp vim-odyssey/colors/odyssey.vim ~/.vim/colors/
```
#### Using [pathogen.vim]
After having installed [pathogen.vim], clone the repository under
`./vim/bundle`.
```zsh
cd ~/.vim/bundle/
git clone https://github.com/ludokng/vim-odyssey.git vim-odyssey/
```
### Updating the `./vimrc`
Add the following to the `./vimrc` file.
+ If 256-colors are required, the following lines must be used:
```vim
set termguicolors
colorscheme odyssey
```
+ If 24-bits colors are required, the following lines must be used:
```vim
set t_Co=256
colorscheme odyssey
```
## License
Odyssey for Vim is distributed under the terms of the MIT license.
[pathogen.vim]: https://github.com/tpope/vim-pathogen