README.md

Gruvbox is a retro groove color scheme for Emacs. It is a port of the Vim version originally by Pavel Pertsev found here.

Theme versions

Gruvbox Dark Medium (aka. Gruvbox default)

Theme name gruvbox-dark-medium

Gruvbox Dark Soft

Theme name gruvbox-dark-soft

Gruvbox Dark Hard

Theme name gruvbox-dark-hard

Gruvbox Light Medium

Theme name gruvbox-light-medium

Gruvbox Light Soft

Theme name gruvbox-light-soft

Gruvbox Light Hard

Theme name gruvbox-light-hard

Palette

Note the dark and light tones are transposed in the light versions.

Mode Support

This theme contains custom support for the following features and plugins:

• Ag.el
• Ace jump
• Ace window
• Anzu
• Auto-dim-other-buffers
• Circe
• Comint (and the like)
• Company
• diff-hl
• Diffs
• Dired+
• Diredfl
• Elfeed
• ElScreen
• ERC
• Eshell
• Flycheck
• Gnus
• Helm
• Highlight Indent
• Hydra
• Ivy
• Js2-mode
• LaTeX
• Linum-relative
• Magit
• Markdown
• Message
• Neotree
• Org
• Popup
• RainbowDelimiters
• Shell script
• Smart modeline
• Smartparens
• Term
• Tool Tips
• Undo Tree
• Whitespace-mode
• Widget Faces

Installation and usage

The recommended way to install the Gruvbox theme is with MELPA.

MELPA

If you're an Emacs 24 user or you have a recent version of package.el you can install the Gruvbox theme from the MELPA repository. The version of gruvbox-theme there will always be up-to-date.

No package.el

The following instructions are for in the case where you don't have access to package.el for some reason.

1. Download gruvbox-theme.el, and put it in ~/.emacs.d/themes. For example:

   curl -L https://raw.github.com/Greduan/emacs-theme-gruvbox/master/gruvbox-theme.el > ~/.emacs.d/themes/gruvbox-theme.el

2. Tell Emacs where to find themes in your init.el or .emacs file:

   (add-to-list 'custom-theme-load-path "~/.emacs.d/themes")

3. Enable the theme:

   M-x load-theme RET gruvbox
   

   Or add the following to your init.el or .emacs file to load the theme at startup:

   (load-theme 'gruvbox t)
   

Issues

See https://github.com/greduan/emacs-theme-gruvbox/issues

If you want the theme to support something please open a new issue and we'll try our best to make it happen. 😄

License

The MIT License (MIT)

Copyright (c) 2013 Lee Machin
              2013-2016 Eduardo Lavaque
              2015-2017 Jason Milkins
              2017-2018 Martijn Terpstra

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.