paper-tonic/README.example.md

55 lines
1.5 KiB
Markdown
Raw Normal View History

2019-05-12 09:38:13 +00:00
# foobar-baz
Here goes your elevator pitch for your colorscheme.
## Requirements
This colorscheme should be accepted by any Vim build or version on any platform without throwing any error but it is specifically designed with the following environments in mind…
2019-05-12 10:56:50 +00:00
### GUI Vim (GVim, MacVim)
2019-05-12 09:38:13 +00:00
2019-05-12 10:56:50 +00:00
The colorscheme should work without any user intervention.
2019-05-12 09:38:13 +00:00
### Color terminals capable of displaying "true colors"
If your terminal emulator is capable of displaying "true colors" and set up to do so, you can tell Vim to use the colorscheme's GUI-specific color definitions instead of those specific to color terminals.
2019-05-12 10:56:50 +00:00
Check your terminal emulator's documentation to see if it supports "true colors" and Vim's `:help xterm-true-color` for additional information.
2019-05-12 09:38:13 +00:00
2019-05-12 10:56:50 +00:00
### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying 16 colors
### Color terminals capable of displaying 8 colors
2019-05-12 09:38:13 +00:00
## Installation
2019-05-12 10:56:50 +00:00
### With a plugin manager
2019-05-12 09:38:13 +00:00
2019-05-12 10:56:50 +00:00
Follow your plugin manager's instructions.
2019-05-12 09:38:13 +00:00
### Manually
Move `colors/foobar-baz.vim` to:
* `$HOME/.vim/colors/foobar-bazvim` on UNIX-like systems,
* `$HOME\vimfiles\colors\foobar-bazvim` on Windows.
## Activation
Add the line below to your `vimrc`:
colorscheme foobar-baz
and either reload your `vimrc`:
:source $MYVIMRC
or start a new Vim session.
NOTE: if you installed foobar-baz with the help of a plugin manager, make sure that line comes *after* any line related in one way or another to your plugin manager.
## Hacking
## Acknowledgements