branch: elpa/gruvbox-theme
commit 173946858331cd9ce0996598c50ad3ee85c92a5e
Author: Greduan <[email protected]>
Commit: Greduan <[email protected]>
Udpated README
---
README.md | 33 +++++++++++++++++++++++++++------
gruvbox-theme.el | 2 +-
2 files changed, 28 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 5526c04adc..2ceda53e98 100644
--- a/README.md
+++ b/README.md
@@ -5,19 +5,40 @@ version originally by [Pavel
Pertsev](https://github.com/morhetz) found
[here](https://github.com/morhetz/gruvbox).
-## Usage
-
-FIXME
-
+## Installation and usage
+
+1. Download `gruvbox-theme.el`, and put it in `~/.emacs.d/themes`. For example:
+ ```shell
+ curl
https://raw.github.com/Greduan/emacs-theme-gruvbox/master/gruvbox-theme.el >
~/.emacs.d/themes/gruvbox-theme.el
+ ```
+
+1. Tell Emacs where to find themes in your `init.el` or `.emacs` file:
+ ```lisp
+ (add-to-list 'custom-theme-load-path "~/.emacs.d/themes")
+ ```
+
+1. 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)
+ ```
## Known bugs
-FIXME
+None. For now...
## To-do
-FIXME
+Add support for:
+
+- [Rainbow Delimiters](http://www.emacswiki.org/emacs/RainbowDelimiters).
+
+If you want for the theme to support something please open a new issue and
I'll try my best to make it work out. :smile:
## License
diff --git a/gruvbox-theme.el b/gruvbox-theme.el
index c6812d8733..7973a538fc 100644
--- a/gruvbox-theme.el
+++ b/gruvbox-theme.el
@@ -105,7 +105,7 @@
`(whitespace-tab ((t (:background ,gruvbox-dark-0 :foreground
,gruvbox-dark-4))))
`(whitespace-newline ((t (:background ,gruvbox-dark-0 :foreground
,gruvbox-dark-4))))
`(whitespace-trailing ((t (:background ,gruvbox-orange))))
- `(whitespace-line ((t (:background ,gruvbox-dark-0 :foreground
,gruvbox-dark-4))))
+ `(whitespace-line ((t (:background nil :foreground nil)))) ;;disable this,
it's annoying
`(whitespace-space-before-tab ((t (:background ,gruvbox-dark-0 :foreground
,gruvbox-dark-4))))
`(whitespace-indentation ((t (:background ,gruvbox-dark-0 :foreground
,gruvbox-dark-4))))
`(whitespace-empty ((t (:background nil :foreground nil))))
