Added README template

This commit is contained in:
Romain Lafourcade 2019-05-01 16:51:42 +02:00 committed by GitHub
parent 10c90c6780
commit 75b7ec1642
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions

35
README.tpl.md Normal file
View File

@ -0,0 +1,35 @@
# Name of your colorscheme
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…
### Color terminals capable of displaying 8 colors
### Color terminals capable of displaying 16 colors
### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying "true colors"
### GUI Vim (GVim, MacVim)
## Installation
### With a `'runtimepath'` manager
Follow your `'runtimepath'` manager's instructions.
### With a plugin manager
Follow your plugin manager's instructions.
### Manually
Move `colors/$COLORSCHEME_NAME.vim` to `$HOME/.vim/colors/$COLORSCHEME_NAME.vim` (on UNIX-like systems) or `$HOME\vimfiles\colors\$COLORSCHEME_NAME.vim` (on Windows).
## Hacking
## Acknowledgements