Update README on installation and more
[mutt-gruvbox.git] / README.md
1 # A gruvbox color scheme for mutt and neomutt
2
3 ## Description
4
5 [Gruvbox](https://github.com/morhetz/gruvbox) is a well designed, popular
6 colorscheme for vim. This is a port to mutt and neomutt, in which vim can act
7 as mail composer.
8
9 This is a replication of the repository
10 [here](https://git.sthu.org/?p=mutt-gruvbox.git;a=summary). The
11 [website](https://www.sthu.org/code/codesnippets/mutt-gruvbox.html) gives
12 further details and a screenshot.
13
14
15 ## Usage
16
17 Download the files or clone the repo, e.g.
18
19 cd ~/.mutt
20 git clone https://git.sthu.org/repos/mutt-gruvbox.git gruvbox
21
22 Then source them in your `~/.mutt/muttrc`, e.g.
23
24 source ~/.mutt/colors-gruvbox-shuber.muttrc
25 # For neomutt also add this line:
26 # source ~/.mutt/colors-gruvbox-shuber-extended.muttrc
27
28 The colorscheme is split into two files, where the latter also defines colors
29 for neomutt.
30
31 ## License
32
33 GNU Lesser General Public License v3.