diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..06ad0de --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright 2021 Kim Silkebækken + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..51f60c0 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# m o n o t o n e + +Another monochrome vim colorscheme. Inspired by various +[other](https://github.com/ewilazarus/preto) +[monochrome](https://github.com/pbrisbin/vim-colors-off) +[colorschemes](https://github.com/fxn/vim-monochrome). + +Monotone is a middle ground between a regular colorscheme and [no syntax +highlighting at all](https://www.kyleisom.net/blog/2012/10/17/syntax-off/). The +colorscheme differentiates comments, strings and keywords with different +weights and shades of gray. It emphasizes errors, warnings and search +highlighting as shown in the screenshots below. + +This is a neovim-specific version of +[vim-monotone](https://github.com/Lokaltog/vim-monotone) based on +[lush.nvim](https://github.com/rktjmp/lush.nvim). This version includes full +support for both dark and light `background`. + +## Installation + +Monotone depends on [lush.nvim](https://github.com/rktjmp/lush.nvim). Example using packer.nvim: + +``` +require('packer').startup(function() + -- ... + use 'rktjmp/lush.nvim' + use 'Lokaltog/monotone.nvim' + -- ... +end) + +api.nvim_command 'colorscheme monotone' +``` + +## Customization + +The theme color may be customized by setting HSL values with +`g:monotone_[hsl]`. + +You may adjust the colorscheme contrast to your liking by setting +`g:monotone_contrast`. + +The default contrast factor is 105. Recommended values are between 90 and 110. + +## Configuration example + +``` +vim.g.monotone_h = 85 +vim.g.monotone_s = 30 +vim.g.monotone_l = 50 +vim.g.monotone_contrast = 110 +vim.g.monotone_true_monotone = true +vim.o.background = 'light' +```