summaryrefslogtreecommitdiff
path: root/README.md
blob: 63370189594de68c61047cb775bd54455c09f595 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
Solarized
=========

**A precision colorscheme for machines and people.** Solarized is a sixteen 
color palette (eight monotones, eight accent colors) designed for use with 
terminal and gui applications and has several unique properties. It has been 
designed with both precise [CIELAB] lightness relationships and a refined set 
of hues based on fixed color wheel relationships. It has been tested 
extensively in real world use on color calibrated displays and in a variety of 
lighting conditions.

Available in formats for:

* **Vim** (a repository with *just* the Vim colorscheme is [available 
  here](https://github.com/altercation/vim-colors-solarized), for use with 
  Pathogen, etc.)
* **Mutt** e-mail client (a repository with *just* the Mutt colorscheme is 
  [available here](https://github.com/altercation/mutt-colors-solarized))
* Adobe Photoshop Palette
* GIMP Palette
* Apple Color Picker Palette
* iTerm2
* OS X Terminal.app
* Xresources / Xdefaults

Download
--------

Downloads, screenshots and more information is available from the project 
homepage: <http://ethanschoonover.com/solarized>.

The git repository is at: https://github.com/altercation/solarized

The vim-only colorscheme (Pathogen ready) is available at: (https://github.com/altercation/vim-colors-solarized

The mutt-only variants can be cloned from https://github.com/altercation/mutt-colors-solarized

Note that through the magic of 
[git-subtree](https://github.com/apenwarr/git-subtree) these repositories are 
all kept in sync, so you can pull any of them and get the most up-to-date 
version.

What
----

Solarized is a sixteen color palette (eight monotones, eight accent colors) 
designed for use with terminal and gui applications and has several unique 
properties. It has been designed with both precise [CIELAB] lightness 
relationships and a refined set of hues based on fixed color wheel 
relationships. It has been tested extensively in real world use on color 
calibrated displays and in a variety of lighting conditions.

Features
--------

1. **Selective contrast**

    Solarized reduces brightness based contrast in general. Modern display 
    devices are capable of blasting your retina clean off with max brightness 
    and I found my eyes growing tired using high contrast colorschemes, even 
    with the brightness turned down. Solarized reduces *brightness contrast* 
    but, unlike many low contrast colorschemes, retains *contrasting hues* 
    (based on colorwheel relations) for syntax highlighting readability.

2. **Dual modes: Dark/Light**

    I switch between dark and light modes when editing text even when editing
    different types of files. Solarized retains the same selective contrast 
    relationships and overall feel when switching between the light and dark 
    background modes. A *lot* of thought, planning and testing has gone into 
    making both modes feel like part of a unified colorscheme.

3. **16/5 Palette modes**

    Solarized works as a sixteen color palette for compatibility with comment
    terminal based applications / emulators. It has been designed to scale down 
    to a variety of five color palettes (four base monotones and one accent 
    color) for use in design work, such as web development.

4.  **Personality that doesn't crowd out the room**

    Solarized can be used as a pure monotone palette, a five-up monotone+accent 
    colorscheme or in full on sixteen color mode for full syntax highlighting.  
    In every case it retains a strong identity but doesn't overwhelm. Like any 
    good supporting actor, it keeps the story moving without chewing up the 
    scenery.

5.  **Precision**

    The monotones have symmetric CIELAB lightness differences, so switching 
    from dark to light mode retains the same perceived contrast in brightness 
    between each value. Each mode is equally readable. The accent colors are 
    based off specific colorwheel relations and subsequently translated to 
    CIELAB to ensure perceptual uniformity in terms of lightness. The hues 
    themselves, as with the monotone \*A\*B values, have been adjusted within 
    a small range to achieve the most pleasing combination of colors.

Download
--------



Installation
------------

Installation instructions for each version of the colorscheme is included in 
the subdirectory's README. Note that for Vim (and possibly for Mutt) you may 
want to clone the specific repository (for instance if you are using Pathogen).  
See the links at the top of this file.

[CIELAB](http://en.wikipedia.org/wiki/Lab_color_space)