Improve instructions

This commit is contained in:
Iron_E 2020-09-05 12:35:42 -04:00
parent 4e937ae75d
commit 884bb3ee3f
No known key found for this signature in database
GPG Key ID: B0B37DE7EDC2335F
1 changed files with 11 additions and 9 deletions

View File

@ -5,7 +5,7 @@ lua << EOF
* Author: Iron-E (https://github.com/Iron-E) * Author: Iron-E (https://github.com/Iron-E)
* Repository: https://github.com/nvim-highlite * Repository: https://github.com/nvim-highlite
Rewrite of RNB, a Vim colorsheme template. Initially forked from vim-rnb, a Vim colorsheme template:
* Author: Romain Lafourcade (https://github.com/romainl) * Author: Romain Lafourcade (https://github.com/romainl)
* Canonical URL: https://github.com/romainl/vim-rnb * Canonical URL: https://github.com/romainl/vim-rnb
]] ]]
@ -35,8 +35,8 @@ lua << EOF
| colorscheme name | module name | template filename | | colorscheme name | module name | template filename |
|:-----------------:|:-----------:|:-----------------:| |:-----------------:|:-----------:|:-----------------:|
| foobar | foobar | foobar.lua | | foobar | foobar | foobar.lua |
| foo-bar | foo_bar | foo-bar.lua | | foo-bar | foo_bar | foo_bar.lua |
| foo bar | foo_bar | foo-bar.lua or | | foo bar | foo_bar | foo_bar.lua |
| foo_bar | foo_bar | foo_bar.lua | | foo_bar | foo_bar | foo_bar.lua |
Rename the following files: Rename the following files:
@ -44,8 +44,12 @@ lua << EOF
* `lua/highlite.lua` * `lua/highlite.lua`
Where 'highlite' is the name of your colorscheme. Where 'highlite' is the name of your colorscheme.
TIP: If you are on a Unix-based system (or have WSL on Windows) you can use the setup script at the root of this repo.
See the README for more details.
]] ]]
--[[ Step 2: Information --[[ Step 2: Information
In this step you will define information that helps Neovim process: In this step you will define information that helps Neovim process:
@ -81,7 +85,7 @@ vim.o.background = 'dark'
]] ]]
local black = {'#202020', 0, 'black'} local black = {'#202020', 0, 'black'}
local gray = {'#808080', 244, 'gray' } local gray = {'#808080', 244, 'gray'}
local gray_dark = {'#353535', 236, 'darkgrey'} local gray_dark = {'#353535', 236, 'darkgrey'}
local gray_darker = {'#505050', 244, 'gray'} local gray_darker = {'#505050', 244, 'gray'}
local gray_light = {'#c0c0c0', 251, 'gray'} local gray_light = {'#c0c0c0', 251, 'gray'}
@ -128,8 +132,6 @@ local purple_light = {'#af60af', 63, 'magenta'}
} }
``` ```
TIP: Any fields which are set to `NONE` can be safely left out.
You can also link one highlight group to another: You can also link one highlight group to another:
```lua ```lua