Working on sample README

This commit is contained in:
Romain Lafourcade 2019-05-12 12:56:50 +02:00
parent 0ff1ffc56d
commit 72892f13cf
3 changed files with 126 additions and 8 deletions

View File

@ -6,25 +6,27 @@ Here goes your elevator pitch for your colorscheme.
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… 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 ### GUI Vim (GVim, MacVim)
### Color terminals capable of displaying 16 colors The colorscheme should work without any user intervention.
### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying "true 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. 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) Check your terminal emulator's documentation to see if it supports "true colors" and Vim's `:help xterm-true-color` for additional information.
The colorscheme should work without any user intervention. ### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying 16 colors
### Color terminals capable of displaying 8 colors
## Installation ## Installation
### With a plugin manager ### With a plugin manager
Follow your plugin manager's instructions. Follow your plugin manager's instructions.
### Manually ### Manually

62
src/README.erb Normal file
View File

@ -0,0 +1,62 @@
<%
# foo
information = {
name: "rnb",
description: "Lorem ipsum dolor sit amet."
}
-%>
# <%= information[:name] %>
<%= information[:description] %>
## 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…
### GUI Vim (GVim, MacVim)
This colorscheme should work without any user intervention.
### 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.
Check your terminal emulator's documentation to see if it supports "true colors" and Vim's `:help xterm-true-color` for additional information.
### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying 16 colors
### Color terminals capable of displaying 8 colors
## Installation
### With a plugin manager
Follow your plugin manager's instructions.
### Manually
Move `colors/<%= information[:name] %>.vim` to:
* `$HOME/.vim/colors/<%= information[:name] %>.vim` on UNIX-like systems,
* `$HOME\vimfiles\colors\<%= information[:name] %>.vim` on Windows.
## Activation
Add the line below to your `vimrc`:
colorscheme <%= information[:name] %>
and either reload your `vimrc`:
:source $MYVIMRC
or start a new Vim session.
NOTE: if you installed <%= information[:name] %> 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

54
src/README.md Normal file
View File

@ -0,0 +1,54 @@
# rnb
Lorem ipsum dolor sit amet.
## 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…
### GUI Vim (GVim, MacVim)
The colorscheme should work without any user intervention.
### 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.
Check your terminal emulator's documentation to see if it supports "true colors" and Vim's `:help xterm-true-color` for additional information.
### Color terminals capable of displaying 256 colors
### Color terminals capable of displaying 16 colors
### Color terminals capable of displaying 8 colors
## 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