[mail] README for mutt-solarized updated

This commit is contained in:
Ethan Schoonover 2011-03-23 11:15:00 -07:00
parent 9fcac97663
commit bd438e745e
1 changed files with 47 additions and 1 deletions

48
README
View File

@ -1 +1,47 @@
mutt-colors-solarized readme file
Solarized Colorscheme for Mutt
==============================
See the [homepage for the Solarized colorscheme][solarized] for versions for
Vim, popular terminal emulators and other applications.
If you have come across this colorscheme via the [mutt-only repository on
github][mutt-solarized-github], see the link above to the Solarized homepage or
visit the [github repository for Solarized][solarized-github].
[solarized]: http://ethanschoonover.com/solarized
[solarized-github]: https://github.com/altercation/solarized
[mutt-solarized-github]: https://github.com/altercation/mutt-colors-solarized
Installation
------------
1. Move the mutt-colors-solarized directory into the same location as your
muttrc. Alternately, you can copy just the version of the colorscheme you
will be using (see below for details).
2. Source the colorscheme in your muttrc. Only one of the following, depending
on the light or dark background you wish to use, and whether you want to use
the native 16 colors of your terminal emulator or the approximatation
provided by the 256 color values. See note below for recommendations.
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-dark-16.muttrc
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-light-16.muttrc
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-dark-256.muttrc
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-light-256.muttrc
Which Variation?
----------------
See the [Solarized homepage][solarized] for screenshots which will help you
select either the light or dark background.
A thornier question is whether to use the 16 color version or the 256 color
version. I have spent a great deal of time refining this colorscheme and for
the most accurate experience I recommend that you set your terminal emulator to
use the Solarized colorvalues with the 16 color mutt colorschemes in this
distribution. Terminal colorschemes/values are available at the homepage linked
to above.
The 256 color versions provide an approximate experience of the colorscheme in
most regards, though the carefully selected monotones are crudely replaced by
neutral tones.