Worked on example README
This commit is contained in:
parent
00783aa593
commit
ae203af90d
|
@ -0,0 +1,52 @@
|
|||
# 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…
|
||||
|
||||
### 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"
|
||||
|
||||
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.
|
||||
|
||||
### GUI Vim (GVim, MacVim)
|
||||
|
||||
The colorscheme should work without any user intervention.
|
||||
|
||||
## Installation
|
||||
|
||||
### With a plugin manager
|
||||
|
||||
Follow your plugin manager's instructions.
|
||||
|
||||
### 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
|
|
@ -13,7 +13,7 @@ The process is divided in four steps:
|
|||
3. define your highlight groups and links,
|
||||
4. and generate your colorscheme.
|
||||
|
||||
Each step is throughly described in the colorscheme template: `src/rnb.erb`.
|
||||
Each step is thoroughly described in the colorscheme template: `src/rnb.erb`.
|
||||
|
||||
## How does it work?
|
||||
|
||||
|
@ -30,3 +30,5 @@ The template is split into two sections of which only the first is of interest t
|
|||
#### Second section: the template
|
||||
|
||||
### The README template
|
||||
|
||||
[//]: # ( Vim: set spell spelllang=en: )
|
||||
|
|
|
@ -1,38 +0,0 @@
|
|||
# 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,
|
||||
* `$HOME\vimfiles\colors\$COLORSCHEME_NAME.vim` on Windows.
|
||||
|
||||
## Hacking
|
||||
|
||||
## Acknowledgements
|
|
@ -113,6 +113,8 @@
|
|||
[ "Underlined", white, darkgray, "NONE" ],
|
||||
[ "StatusLine", white, darkgray, "NONE" ],
|
||||
[ "StatusLineNC", white, darkgray, "NONE" ],
|
||||
[ "StatusLineTerm", "StatusLine" ],
|
||||
[ "StatusLineTermNC", "StatusLineNC" ],
|
||||
[ "VertSplit", white, darkgray, "NONE" ],
|
||||
[ "TabLine", white, darkgray, "NONE" ],
|
||||
[ "TabLineFill", white, darkgray, "NONE" ],
|
||||
|
@ -154,9 +156,7 @@
|
|||
[ "WarningMsg", "Error" ],
|
||||
[ "Cursor", white, darkgray, "NONE" ],
|
||||
[ "CursorColumn", white, darkgray, "NONE" ],
|
||||
[ "QuickFixLine", white, darkgray, "NONE" ],
|
||||
[ "StatusLineTerm", white, darkgray, "NONE" ],
|
||||
[ "StatusLineTermNC", white, darkgray, "NONE" ]
|
||||
[ "QuickFixLine", white, darkgray, "NONE" ]
|
||||
]
|
||||
|
||||
# Define the color palette used by :terminal when in GUI Vim
|
||||
|
|
Loading…
Reference in New Issue