From 5610c3f4f7031c2c9a8866e7a2fcff5de8ef9c3d Mon Sep 17 00:00:00 2001 From: Michael Chris Lopez Date: Sun, 7 Nov 2021 08:37:59 +0800 Subject: [PATCH] doc: cleanup --- README.md | 6 +++--- doc/zenbones.md | 28 +++++++++++----------------- 2 files changed, 14 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index e86eae2..fc03d03 100644 --- a/README.md +++ b/README.md @@ -112,9 +112,9 @@ currently supported. - [WezTerm](extras/wezterm) - [Tmux](extras/tmux) -It's also possible to generate any color configuration files using a template, -[this one for Kitty](lua/zenbones/template/kitty.lua) for example. Please feel -free to submit a PR if you want to add some more. +It's also possible to generate any color configuration files using shipwright, +[this one for Kitty](lua/zenbones/shipwright/runners/kitty.lua) for example. +Please feel free to submit a PR if you want to add some more. ## Inspirations diff --git a/doc/zenbones.md b/doc/zenbones.md index 8636a93..cf19ee3 100644 --- a/doc/zenbones.md +++ b/doc/zenbones.md @@ -14,20 +14,18 @@ set background=light " or dark colorscheme zenbones -colorscheme zenwritten " Zero hue and saturation version -colorscheme neobones " https://neovim.io flavor -colorscheme vimbones " https://www.vim.org flavor -colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com -colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest -colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes -colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette -colorscheme duckbones " Spaceduck flavor - https://pineapplegiant.github.io/spaceduck -colorscheme zenburned " Zenburn flavor - https://kippura.org/zenburnpage +" or any from the collection +colorscheme zenwritten +colorscheme neobones +colorscheme vimbones +colorscheme rosebones +colorscheme forestbones +colorscheme nordbones +colorscheme tokyobones +colorscheme duckbones +colorscheme zenburned ``` -It works pretty much the same as the first one but pretty handy when extending -or customizing the colors to your likings. - ## Configuration Configuration is only available for Neovim. There are two ways to set @@ -82,7 +80,7 @@ the flavor name e.g. `g:rosebones_italic_comments`. #### g:zenbones_compat -Set to `1` to enable compatibility mode. Enable in Vim. +Set to `1` to enable compatibility mode. Enabled in Vim. ### lightline @@ -212,7 +210,3 @@ require("zenbones.term").apply_colors(palette) And there you have it. Just call `colorscheme gruvbones` to use your new colorscheme. It respects `&background` and other configurations too. - -Also checkout the [neobones](../colors/neobones.lua) and -[rosebones](../colors/rosebones.lua) colorscheme for a similar and complete -example.