rayelliott
/
paper-tonic
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Better usage outline

This commit is contained in:
Romain Lafourcade 2019-05-12 13:50:50 +02:00
parent cb0b3602ea
commit 7643b93928
2 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -18,14 +18,15 @@ In reality, Vim colorschemes are not that hard to write but there are several be
## How do I use it? ## How do I use it?
The process is divided in four steps: The process is divided in five steps:
1. start by editing your colorscheme's information, 1. rename `colors/rnb.erb` to `colors/name_of_your_colorscheme.erb`,
2. define your colors, 2. start by editing your colorscheme's information,
3. define your highlight groups and links, 3. define your colors,
4. and generate your colorscheme. 4. define your highlight groups and links,
5. and generate your colorscheme.
Each step is thoroughly described in the colorscheme template: `src/rnb.erb`. Each step is thoroughly described in the colorscheme template: `colors/rnb.erb`.
## TODO ## TODO

25
colors/rnb.erb
View File

@ -1,7 +1,7 @@
<% <%
# RNB, A VIM COLORSCHEME TEMPLATE # RNB, A VIM COLORSCHEME TEMPLATE
# Author: Romain Lafourcade (https://github.com/romainl) # Author: Romain Lafourcade (https://github.com/romainl)
# Canonical URL: https://gist.github.com/romainl/5cd2f4ec222805f49eca # Canonical URL: https://github.com/romainl/vim-rnb
# This template is designed to help vimmers create their own colorschemes # This template is designed to help vimmers create their own colorschemes
# without much effort. # without much effort.
@ -9,13 +9,14 @@
# You will need Ruby to generate your colorscheme but Ruby knowledge is # You will need Ruby to generate your colorscheme but Ruby knowledge is
# not needed at all. # not needed at all.
# #
# The process is divided in four steps: # The process is divided in five steps:
# 1. start by editing your colorscheme's information, # 1. rename `colors/rnb.erb` to `colors/name_of_your_colorscheme.erb`,
# 2. define your colors, # 2. start by editing your colorscheme's information,
# 3. define your highlight groups and links, # 3. define your colors,
# 4. and generate your colorscheme. # 4. define your highlight groups and links,
# 5. and generate your colorscheme.
# Step 1: information # Step 2: information
# #
# Make sure the name of your colorscheme is unique and attractive. # Make sure the name of your colorscheme is unique and attractive.
# The description should fit in a single line with no linefeed. # The description should fit in a single line with no linefeed.
@ -29,7 +30,7 @@
webpage: "http://www.example.com" webpage: "http://www.example.com"
} }
# Step 2: colors # Step 3: colors
# #
# black = [ give each color a distinctive name # black = [ give each color a distinctive name
# "#000000", hexadecimal color used in GVim/MacVim or "NONE" # "#000000", hexadecimal color used in GVim/MacVim or "NONE"
@ -63,7 +64,7 @@
cyan = ["#00ffff", 14, "cyan"] cyan = ["#00ffff", 14, "cyan"]
white = ["#ffffff", 15, "white"] white = ["#ffffff", 15, "white"]
# Step 3: highlights # Step 4: highlights
# #
# You can define highlight groups like this: # You can define highlight groups like this:
# #
@ -185,12 +186,16 @@
white white
] ]
# Step 4: generation # Step 5: generation
# #
# From a separate shell: # From a separate shell:
# #
# $ erb -T - bar.erb > bar.vim # $ erb -T - bar.erb > bar.vim
# #
# From a separate shell, with the make program:
#
# $ make
#
# From Vim: # From Vim:
# #
# :!erb -T - % > %<.vim # :!erb -T - % > %<.vim