commit fb339632baf11d7aea98e6b715ad86e33ab5f170 Author: Fernando Schauenburg Date: Sat Jul 22 01:12:43 2023 +0200 Let's go... diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e91e5ca --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ + The MIT License (MIT) + +Copyright © 2023 Fernando Schauenburg + +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..add5fe8 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Gruvbox + +A really simple [gruvbox color scheme][gruvbox] for Neovim, written to be as +simple as it gets and based on my [solarized theme][solarized]. + +[gruvbox]: https://github.com/morhetz/gruvbox +[solarized]: https://github.com/fschauen/solarized.nvim + +## Why? + +Why not? 😉 + +## Getting Started + +### Requirements + +- Neovim (duh 😛) +- `vim.opt.termguicolors = true` in your `init.lua`. +- A terminal with [true color support][truecolor]. + +[truecolor]: https://github.com/termstandard/colors + +### Installation + +Install with your favorite package manager, e.g with [lazy.nvim][lazy]: + +```lua +require('lazy').setup { + 'fschauen/gruvbox.nvim' +} +``` + +[lazy]: https://github.com/folke/lazy.nvim + +### Setup + +Just type: + +```viml +:colorscheme gruvbox +``` + +or add this to your `init.lua`: + +```lua +vim.cmd [[colorscheme gruvbox]] +``` + +### Options + +None. This is supposed to be simple, remember? + +## Supported Plugins + +- [indent-blankline](https://github.com/lukas-reineke/indent-blankline.nvim) +- [lualine](https://github.com/nvim-lualine/lualine.nvim) +- [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) +- [nvim-tree](https://github.com/kyazdani42/nvim-tree.lua) +- [telescope](https://github.com/nvim-telescope/telescope.nvim) +- [vim-better-whitespace](https://github.com/ntpeters/vim-better-whitespace) +- [vim-fugitive](https://github.com/tpope/vim-fugitive) +- [virt-column.nvim](https://github.com/lukas-reineke/virt-column.nvim) +