Files
gruvbox/README.md

71 lines
1.7 KiB
Markdown

gruvbox
=======
Retro groove color scheme for Vim.
Gruvbox is heavily inspired by [badwolf][1], [jellybeans][2] and [solarized][3].
Designed as a bright theme with pastel 'retro groove' colors and light/dark mode switching in the way of [solarized][3]. The main focus when developing Gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.
[1]: https://github.com/sjl/badwolf
[2]: https://github.com/nanotech/jellybeans.vim
[3]: http://ethanschoonover.com/solarized
Screenshots
-----------
Color scheme is in early development stage, so this could serve as working preview.
### Dark mode
![Screenshot](http://i.imgur.com/2870c.png)
### Light mode
![Screenshot](http://i.imgur.com/oS9I3.png)
Features
--------
* Distraction-free HTML highlighting
* Hand-tuned plugin-specific highlighting for [EasyMotion][4], [Better Rainbow Parentheses][5] and [Indent Guides][6]
[4]: https://github.com/Lokaltog/vim-easymotion
[5]: https://github.com/kien/rainbow_parentheses.vim
[6]: https://github.com/nathanaelkane/vim-indent-guides
Usage
-----
gruvbox comes in two modes, dark and light. To toggle between them with F5 you can add these to your .vimrc
map <F5> :call ToggleBg()<CR>
function! ToggleBg()
if &background == 'dark'
set bg=light
else
set bg=dark
endif
colo gruvbox
endfunc
Just setting background to an appropriate value would work as well
set bg=dark " Setting dark mode
set bg=light " Setting light mode
ToDo
----
* Terminal low-color mode (&lt;256)
* More fyletype specific highlighting
* Customizable options (overrides, background switch, etc.)
* Powerline colors
License
-------
[MIT/X11][]
[MIT/X11]: https://en.wikipedia.org/wiki/MIT_License