2019-05-01 19:53:57 +00:00
# Vim-RNB, a Vim colorscheme template
## What is this thing?
RNB is a template designed to help vimmers create their own colorschemes without much effort.
2019-05-12 11:40:20 +00:00
In reality, Vim colorschemes are not that hard to write but there are several benefits to using a template such as RNB:
* you can define/modify variables once instead of messing around with potentially botched substitutions,
* you can distribute a lean colorscheme, free from unnecessary logic,
2019-06-07 13:29:04 +00:00
* you can distribute the source alongside the colorscheme, making it easy for your users to experiment and adapt *your* colorscheme to *their* needs,
2019-05-12 11:40:20 +00:00
* you can focus on the design of your colorscheme rather than its implementation,
* you can start working on new colorscheme ideas very easily.
## What do I need to use it?
[ERB ](https://ruby-doc.org/stdlib-2.6.3/libdoc/erb/rdoc/index.html ), the templating engine used here, is part of Ruby's standard library so you will need [Ruby ](https://www.ruby-lang.org/ ) to generate your colorscheme. Neither ERB nor Ruby knowledge is required, though.
2019-05-01 19:53:57 +00:00
## How do I use it?
2019-05-12 11:50:50 +00:00
The process is divided in five steps:
2019-05-01 19:53:57 +00:00
2019-05-12 11:50:50 +00:00
1. rename `colors/rnb.erb` to `colors/name_of_your_colorscheme.erb` ,
2. start by editing your colorscheme's information,
3. define your colors,
4. define your highlight groups and links,
5. and generate your colorscheme.
2019-05-01 19:53:57 +00:00
2019-06-07 13:29:04 +00:00
Steps 2 to 5 are thoroughly described in the colorscheme template itself in an effort to make it portable: if you ever decide to distribute your colorscheme you can simply package the template with it.
2019-05-01 19:53:57 +00:00
2020-04-13 08:43:16 +00:00
## Built with RNB
The following colorschemes are known to be built with RNB:
* [Apprentice ](https://github.com/romainl/Apprentice )
* [Dichromatic ](https://github.com/romainl/vim-dichromatic )
* [Bruin ](https://git.sr.ht/~romainl/vim-bruin )
* [Sweet16 ](https://github.com/romainl/vim-sweet16 )
* [Paper ](https://github.com/swalladge/paper.vim )
* [Journeyman ](https://github.com/markeganfuller/vim-journeyman )
2020-04-13 08:48:52 +00:00
* [Warlock ](https://github.com/hardselius/warlock )
* [Cyberpunk-Neon ](https://github.com/Roboron3042/Cyberpunk-Neon )
* [Tutfish ](https://github.com/benwr/tuftish )
2020-04-13 08:43:16 +00:00
* (your colorscheme here, send us a PR!)
2019-05-12 11:40:20 +00:00
## TODO
2019-05-01 19:53:57 +00:00
2019-05-12 11:40:20 +00:00
* `README.md` template
2019-05-01 19:53:57 +00:00
2019-05-12 09:38:13 +00:00
[//]: # ( Vim: set spell spelllang=en: )
