Merge branch 'feature/setup-script' into master

This commit is contained in:
Iron_E 2020-09-03 12:50:49 -04:00
commit c0adc8566e
No known key found for this signature in database
GPG Key ID: B0B37DE7EDC2335F
2 changed files with 19 additions and 1 deletions

View File

@ -30,7 +30,21 @@ This template's _design_ focuses on:
# Usage
This repository should be cloned with `git clone https://github.com/Iron-E/nvim-highlite`, and then follow the instructions in [`colors/highlite.vim`](colors/highlite.vim).
1. This repository should be forked, or cloned with `git clone https://github.com/Iron-E/nvim-highlite`.
2. Follow the instructions in [`colors/highlite.vim`](colors/highlite.vim).
* If you are on a Unix system, use the [setup script](setup.sh) like so:
```sh
chmod +x ./setup.sh
./setup.sh highlite <colorscheme>
```
Where `<colorscheme>` is the name of your desired colorscheme.
* If you are on Windows, rename the files manually.
## FAQ
> Why am I receiving `E5108: Error executing lua [string ":lua"]:1: module '<colorscheme>' not found`?
* Ensure your colorscheme's base folder is in Neovim's `rtp` before sourcing.
## Examples

4
setup.sh Executable file
View File

@ -0,0 +1,4 @@
mv "lua/$1.lua" "lua/$2.lua"
sed "s/$1/$2/g" "colors/$1.vim" > "colors/$2.vim"
rm "colors/$1.vim"