paper-tonic/README.md

40 lines
1.8 KiB
Markdown

# Default Settings Preview
![lua preview](./media/preview.png "Lua Preview")
# Introduction
`nvim-highlite` is a colorscheme template repository for Neovim 0.5+.
This template's focus is on two things:
1. Compatability with [semantic highlighting](https://medium.com/@evnbr/coding-in-color-3a6db2743a1e).
* I was using colorschemes that often did not provide enough highlight groups to provide distinction between tokens.
2. Visibility in any range of blue-light.
* I use redshift often, and I many colorschemes did not allow for me to see when I had lower color temperatures.
It provides a large supply of defaults for plugins and programming languages as a result of defining a smaller set of "categorical" highlights (you can read more about this at Neovim's `group-name` help page).
# Prerequisites
1. Neovim 0.5+
# Usage
This repository should be cloned with `git clone https://github.com/Iron-E/nvim-highlite`, and then:
1. Rename `lua/highlite/` to `lua/<name of your colorscheme>/`.
2. Follow the directions in [lua/`<name of your colorscheme>`/init.lua](lua/highlite/init.lua).
3. Rename `colors/highlite.vim` to `colors/<name of your colorscheme>.vim`.
4. Follow the instructions in [colors/`<name of your colorscheme>`.vim](colors/highlite.vim).
5. Install the colorscheme:
* With a plugin manager (like [`vim-plug`](https://github.com/junegunn/vim-plug)).
* By merging the [colors](colors) and [lua](lua) folders with the ones in your `stdpath('config')` directory.
6. Source with `colorscheme highlite` / `colorscheme <name of colorscheme>` in your [init.vim]($HOME/.config/init.vim).
## Examples
This repository in itself is an example of how to use `nvim-highlite`. Aside from this, the following colorschemes are built using `nvim-highlite`:
* (if you use this, open an issue and I'll add it here!)