commit f636991d92d922890b94955d624dd5466194b309
parent 9fc8bfe38f131243fa05080f0b71a25569b6356e
Author: Alex Balgavy <8124851+thezeroalpha@users.noreply.github.com>
Date: Fri, 6 Mar 2020 01:33:18 +0100
Update README.md
Diffstat:
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
# Schemer: a Vim colorscheme generator
## What?
This plugin defines a much simpler language for writing colorschemes, and generates a Vim colorscheme file automatically, including all necessary boilerplate.
+It gives you an empty slate: if you don't define anything in your colors heme, you get an empty colors heme (as opposed to the default that Vim uses).
It consists of:
* a new filetype, 'schemer', with the extension '.schemer'
@@ -10,6 +11,12 @@ It consists of:
* `<Plug>SchemerSynstack` to echo the highlight groups of the word under the cursor
* `<Plug>SchemerEdit` to open the '.schemer' file for the current colorscheme. Assumes the '.schemer' file is in ~/.vim/colors.
+This plugin is not meant to be compatible with everything that can run Vim.
+If you don't set `termguicolors`, the colors used will be approximations.
+That's fine for me, but might not be fine for you.
+
+It's also likely slower and less efficient than it could be.
+
## Why?
I like making my own colorschemes, I don't like dealing with Vim's syntax.
I wanted something simpler and more intuitive.
@@ -70,5 +77,9 @@ Also, it still feels too detailed, and there's too much writing.
That sounds like a childish complaint, but I wanted to make writing colorschemes as simple as possible for me.
Having to specify the details of every color without actually needing that level of control was too much.
-However, this is mainly for me.
+Another option is [colortemplate](https://github.com/lifepillar/vim-color template), which is pretty close to what I want.
+However, I found that it's a bit too much for my purposes, and I prefer my syntax.
+If you want something that gives you more control, more compatibility, and a richer syntax, I'd recommend colortemplate.
+
+This plugin is mainly for me.
It might not make sense for you, and you might prefer the control you get from other colorscheme generators, which is fine.
