Files
vim-odyssey/README.md
T
Ludovic Koenig c8224d3450 Add a note for the installation directives
The note is about some specifics of the Vim native package manager.

It closes #4 on Github.
2019-09-25 22:38:31 +02:00

64 lines
1.3 KiB
Markdown

# Odyssey for Vim
Odyssey is a dark green colorscheme for Vim.
## Features
## Installation
### Downloading the plugin
#### 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/
```
#### Using Vim 8 native package manager
Clone the repository under `.vim/pack/vim-odyssey/start/`.
```zsh
cd ~/.vim/pack/
mkdir -p vim-odyssey/start/
cd vim-odyssey/start/
git clone https://github.com/ludokng/vim-odyssey.git vim-odyssey/
```
*Note*: The first `vim-odyssey` directory name is arbitrary as specified in the
Vim documentation.
### Updating the `./vimrc`
Add the following to the `./vimrc` file.
+ For GUI versions of Vim:
```vim
colorscheme odyssey
```
+ For terminals that support true color, if 24-bits colors are required, the
following lines must be used:
```vim
set termguicolors
colorscheme odyssey
```
+ For terminals that support 256-colors, if 8-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