improve readme

This commit is contained in:
Michael Chris Lopez
2021-10-27 17:14:39 +08:00
parent 681bcff0db
commit cc2cf64f05
3 changed files with 22 additions and 14 deletions

View File

@@ -29,7 +29,7 @@ jobs:
# Output vimdoc project name
vimdoc: zenbones
pandoc: doc/zenbones.md
description: "A contrast-focused vim/neovim colorscheme"
description: "A collection of contrast-based vim/neovim colorschemes"
version: "Vim v8.1 / Neovim 0.5.0"
- uses: stefanzweifel/git-auto-commit-action@v4
with:

View File

@@ -4,6 +4,10 @@ Zenbones is a vim/neovim colorscheme designed to highlight code using contrasts
and font variations. Colors are tasked only for other roles such as diagnostics,
diffs, search matches.
It is carefully crafted for extensibility. You can
[create your own zenbones-based colorscheme](doc/zenbones.md#create-your-own-colorscheme)
or try the [built-in collection](#usage).
![Zenbones main image](https://user-images.githubusercontent.com/7200153/133883977-116795f3-c602-45f0-8907-b89c8d0b2f82.jpg)
<p align="center">
@@ -35,6 +39,8 @@ use {
Just apply the colorscheme as usual:
```vim
set termguicolors
colorscheme zenbones " light
colorscheme zenflesh " dark

View File

@@ -9,6 +9,8 @@ as diagnostics, diffs, search matches.
Just apply the colorscheme as usual:
```vim
set termguicolors
colorscheme zenbones " light
colorscheme zenflesh " dark
@@ -180,7 +182,7 @@ more options.
### Create your own colorscheme
You can ultimately create your own colorscheme that is based on Zenbones by
You can ultimately create your own colorscheme that is based on zenbones by
defining a palette and generating a specs. Best way to demonstrate this is
through an example. Let's make a zenbones-flavored Gruvbox colorscheme called
`gruvbones`.