merge conflict resolution

This commit is contained in:
Trevor Bramble 2012-08-12 23:50:18 -07:00
commit 0c5fbc71bf

124
README.md
View file

@ -17,13 +17,13 @@ Solarized
[![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-yinyang.png)](#features)\ [![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-yinyang.png)](#features)\
Solarized is a sixteen color palette (eight monotones, eight accent colors) Solarized is a sixteen color palette (eight monotones, eight accent colors)
designed for use with terminal and gui applications. It has several [unique designed for use with terminal and gui applications. It has several [unique
properties](#features). I designed this colorscheme with both precise properties](#features). I designed this colorscheme with both precise
[CIELAB](http://en.wikipedia.org/wiki/Lab_color_space) lightness relationships [CIELAB](http://en.wikipedia.org/wiki/Lab_color_space) lightness relationships
and a refined set of hues based on fixed color wheel relationships. It has been 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 (as well as tested extensively in real world use on color calibrated displays (as well as
uncalibrated/intentionally miscalibrated displays) and in a variety of lighting uncalibrated/intentionally miscalibrated displays) and in a variety of lighting
conditions. conditions.
***See the [changelog] for what's new in the most recent release.*** ***See the [changelog] for what's new in the most recent release.***
@ -36,9 +36,9 @@ Currently available in formats for (cf [screenshots](#screenshots) below):
### Editors & IDEs ### Editors & IDEs
* **Vim** by [me](https://github.com/altercation) (the Vim-only portion of Solarized is * **Vim** by [me](https://github.com/altercation) (the Vim-only portion of Solarized is
[available here][Vim Repository], for use with Pathogen, etc.). [available here](https://github.com/altercation/vim-colors-solarized), for use with
See also the [Vim README]. Pathogen, etc.). See also the [Vim README](http://ethanschoonover.com/solarized/vim-colors-solarized).
* **Emacs** courtesy of [Greg Pfeil](http://blog.technomadic.org) * **Emacs** courtesy of [Greg Pfeil](http://blog.technomadic.org)
([@sellout](http://twitter.com/sellout)) ([@sellout](http://twitter.com/sellout))
in the main repo and in a [standalone repository][Emacs Repository] in the main repo and in a [standalone repository][Emacs Repository]
* **IntelliJ IDEA** * **IntelliJ IDEA**
@ -48,24 +48,24 @@ Currently available in formats for (cf [screenshots](#screenshots) below):
* **NetBeans** courtesy of [Brian Fenton](https://github.com/fentie) and * **NetBeans** courtesy of [Brian Fenton](https://github.com/fentie) and
in the main repo and in a [standalone repository][NetBeans Repository] in the main repo and in a [standalone repository][NetBeans Repository]
* **SeeStyle theme for Coda & SubEthaEdit** courtesy of * **SeeStyle theme for Coda & SubEthaEdit** courtesy of
[Justin Hileman](http://justinhileman.com/) [Justin Hileman](http://justinhileman.com/)
([@bobthecow](http://twitter.com/bobthecow)), ([@bobthecow](http://twitter.com/bobthecow)),
in the main repo and in a in the main repo and in a
[standalone repository][SeeStyle-Coda-SubEthaEdit Repository] [standalone repository][SeeStyle-Coda-SubEthaEdit Repository]
* **TextMate** --- ***NOTE:*** Dark Theme is work in progress\ * **TextMate** --- ***NOTE:*** Dark Theme is work in progress\
courtesy of [Tom Martin](http://thedeplorableword.net/) courtesy of [Tom Martin](http://thedeplorableword.net/)
([@deplorableword](http://twitter.com/deplorableword)) ([@deplorableword](http://twitter.com/deplorableword))
in the main repo and in a [standalone repository][TextMate Repository] in the main repo and in a [standalone repository][TextMate Repository]
(with key work from [Mark Story](http://mark-story.com) (with key work from [Mark Story](http://mark-story.com)
and [Brian Mathiyakom](http://brian.rarevisions.net)) and [Brian Mathiyakom](http://brian.rarevisions.net))
* **TextWrangler & BBEdit** courtesy of [Rui Carmo](http://the.taoofmac.com) * **TextWrangler & BBEdit** courtesy of [Rui Carmo](http://the.taoofmac.com)
([@taoofmac](http://twitter.com/taoofmac)) ([@taoofmac](http://twitter.com/taoofmac))
in the main repo and in a [standalone repository][TextWrangler-BBEdit Repository] in the main repo and in a [standalone repository][TextWrangler-BBEdit Repository]
* **Visual Studio** courtesy of [David Thibault](http://www.leddt.com) * **Visual Studio** courtesy of [David Thibault](http://www.leddt.com)
([@leddt](http://twitter.com/leddt)) ([@leddt](http://twitter.com/leddt))
in the main repo and in a [standalone repository][Visual Studio Repository] in the main repo and in a [standalone repository][Visual Studio Repository]
* **Xcode** work in progress ports are available for [Xcode 3] and [Xcode 4] * **Xcode** work in progress ports are available for [Xcode 3] and [Xcode 4]
and will be pulled into the main Solarized project soon. and will be pulled into the main Solarized project soon.
### Terminal Emulators ### Terminal Emulators
@ -87,10 +87,10 @@ Currently available in formats for (cf [screenshots](#screenshots) below):
* **Apple Color Picker** Palettes * **Apple Color Picker** Palettes
* **GIMP** Palette * **GIMP** Palette
Don't see the application you want to use it in? Download the palettes (or pull Don't see the application you want to use it in? Download the palettes (or pull
the values from the table below) and create your own. Submit it back and I'll the values from the table below) and create your own. Submit it back and I'll
happily note the contribution and include it on this page. See also the happily note the contribution and include it on this page. See also the
[Usage & Development](#usage-development) section below for details on the [Usage & Development](#usage-development) section below for details on the
specific values to be used in different contexts. specific values to be used in different contexts.
Download Download
@ -98,12 +98,12 @@ Download
### [Click here to download latest version](http://ethanschoonover.com/solarized/files/solarized.zip) ### [Click here to download latest version](http://ethanschoonover.com/solarized/files/solarized.zip)
Current release is **v1.0.0beta2**. See the [changelog] for details on what's Current release is **v1.0.0beta2**. See the [changelog] for details on what's
new in this release. new in this release.
### Fresh Code on GitHub ### Fresh Code on GitHub
You can also use the following links to access application specific downloads You can also use the following links to access application specific downloads
and git repositories: and git repositories:
* **Canonical Project Page:** * **Canonical Project Page:**
@ -120,7 +120,7 @@ and git repositories:
* **Application Specific Repositories:** * **Application Specific Repositories:**
You can clone repositories specific to many of the application specific You can clone repositories specific to many of the application specific
color themes. See links in the list above or select from this list: color themes. See links in the list above or select from this list:
* [Vim Repository] * [Vim Repository]
@ -144,18 +144,18 @@ Features
1. **Selective contrast** 1. **Selective contrast**
On a sunny summer day I love to read a book outside. Not right in the sun; On a sunny summer day I love to read a book outside. Not right in the sun;
that's too bright. I'll hunt for a shady spot under a tree. The shaded that's too bright. I'll hunt for a shady spot under a tree. The shaded
paper contrasts with the crisp text nicely. If you were to actually measure paper contrasts with the crisp text nicely. If you were to actually measure
the contrast between the two, you'd find it is much lower than black text the contrast between the two, you'd find it is much lower than black text
on a white background (or white on black) on your display device of choice. on a white background (or white on black) on your display device of choice.
Black text on white from a computer display is akin to reading a book in Black text on white from a computer display is akin to reading a book in
direct sunlight and tires the eye. direct sunlight and tires the eye.
![solarized selective contrast](https://github.com/altercation/solarized/raw/master/img/solarized-selcon.png)\ ![solarized selective contrast](https://github.com/altercation/solarized/raw/master/img/solarized-selcon.png)\
Solarized reduces *brightness contrast* but, unlike many low contrast Solarized reduces *brightness contrast* but, unlike many low contrast
colorschemes, retains *contrasting hues* (based on colorwheel relations) colorschemes, retains *contrasting hues* (based on colorwheel relations)
for syntax highlighting readability. for syntax highlighting readability.
2. **Both sides of the force** 2. **Both sides of the force**
@ -163,9 +163,9 @@ Features
![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-dualmode.png)\ ![solarized dualmode](https://github.com/altercation/solarized/raw/master/img/solarized-dualmode.png)\
I often switch between dark and light modes when editing text and code. I often switch between dark and light modes when editing text and code.
Solarized retains the same selective contrast relationships and overall Solarized retains the same selective contrast relationships and overall
feel when switching between the light and dark background modes. A *lot* of 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 thought, planning and testing has gone into making both modes feel like
part of a unified colorscheme. part of a unified colorscheme.
3. **16/5 palette modes** 3. **16/5 palette modes**
@ -173,8 +173,8 @@ Features
![solarized palettes](https://github.com/altercation/solarized/raw/master/img/solarized-165.png)\ ![solarized palettes](https://github.com/altercation/solarized/raw/master/img/solarized-165.png)\
Solarized works as a sixteen color palette for compatibility with common Solarized works as a sixteen color palette for compatibility with common
terminal based applications / emulators. In addition, it has been carefully terminal based applications / emulators. In addition, it has been carefully
designed to scale down to a variety of five color palettes (four base designed to scale down to a variety of five color palettes (four base
monotones plus one accent color) for use in design work such as web design. monotones plus one accent color) for use in design work such as web design.
In every case it retains a strong personality but doesn't overwhelm. In every case it retains a strong personality but doesn't overwhelm.
@ -182,19 +182,19 @@ Features
![solarized symmetry](https://github.com/altercation/solarized/raw/master/img/solarized-sym.png)\ ![solarized symmetry](https://github.com/altercation/solarized/raw/master/img/solarized-sym.png)\
The monotones have symmetric CIELAB lightness differences, so switching The monotones have symmetric CIELAB lightness differences, so switching
from dark to light mode retains the same perceived contrast in brightness from dark to light mode retains the same perceived contrast in brightness
between each value. Each mode is equally readable. The accent colors are between each value. Each mode is equally readable. The accent colors are
based off specific colorwheel relations and subsequently translated to based off specific colorwheel relations and subsequently translated to
CIELAB to ensure perceptual uniformity in terms of lightness. The hues CIELAB to ensure perceptual uniformity in terms of lightness. The hues
themselves, as with the monotone \*a\*b values, have been adjusted within themselves, as with the monotone \*a\*b values, have been adjusted within
a small range to achieve the most pleasing combination of colors. a small range to achieve the most pleasing combination of colors.
See also the [Usage & Development](#usage-development) section below for See also the [Usage & Development](#usage-development) section below for
details on the specific values to be used in different contexts. details on the specific values to be used in different contexts.
This makes colorscheme inversion trivial. Here, for instance, is a sass This makes colorscheme inversion trivial. Here, for instance, is a sass
(scss) snippet that inverts solarized based on the class of the html tag (scss) snippet that inverts solarized based on the class of the html tag
(e.g. `<html class="dark red">` to give a dark background with red accent): (e.g. `<html class="dark red">` to give a dark background with red accent):
$base03: #002b36; $base03: #002b36;
@ -213,7 +213,7 @@ Features
$blue: #268bd2; $blue: #268bd2;
$cyan: #2aa198; $cyan: #2aa198;
$green: #859900; $green: #859900;
@mixin rebase($rebase03,$rebase02,$rebase01,$rebase00,$rebase0,$rebase1,$rebase2,$rebase3) @mixin rebase($rebase03,$rebase02,$rebase01,$rebase00,$rebase0,$rebase1,$rebase2,$rebase3)
{ {
background-color:$rebase03; background-color:$rebase03;
color:$rebase0; color:$rebase0;
@ -238,15 +238,15 @@ Features
Installation Installation
------------ ------------
Installation instructions for each version of the colorscheme are included in Installation instructions for each version of the colorscheme are included in
the subdirectory README files. Note that for Vim (and possibly for Mutt) you the subdirectory README files. Note that for Vim (and possibly for Mutt) you
may want to clone the specific repository (for instance if you are using may want to clone the specific repository (for instance if you are using
Pathogen). See the links at the top of this file. Pathogen). See the links at the top of this file.
Font Samples Font Samples
------------ ------------
Solarized has been designed to handle fonts of various weights and retain Solarized has been designed to handle fonts of various weights and retain
readability, from the classic Terminus to the beefy Menlo. readability, from the classic Terminus to the beefy Menlo.
![font samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-fontsamples-light.png) ![font samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-fontsamples-light.png)
@ -254,7 +254,7 @@ readability, from the classic Terminus to the beefy Menlo.
Clockwise from upper left: Menlo, Letter Gothic, Terminus, Andale Mono. Clockwise from upper left: Menlo, Letter Gothic, Terminus, Andale Mono.
Preview all code samples in specific font faces by selecting a link from this Preview all code samples in specific font faces by selecting a link from this
list: list:
* [DejaVu Sans 18](http://ethanschoonover.com/solarized/img/dejavusans18/) * [DejaVu Sans 18](http://ethanschoonover.com/solarized/img/dejavusans18/)
@ -344,7 +344,7 @@ These screen shots show Vim running with my own [Pandoc Kit Syntax](http://ethan
The Values The Values
---------- ----------
L\*a\*b values are canonical (White D65, Reference D50), other values are L\*a\*b values are canonical (White D65, Reference D50), other values are
matched in sRGB space. matched in sRGB space.
SOLARIZED HEX 16/8 TERMCOL XTERM/HEX L*A*B RGB HSB SOLARIZED HEX 16/8 TERMCOL XTERM/HEX L*A*B RGB HSB
@ -369,28 +369,28 @@ matched in sRGB space.
Usage & Development Usage & Development
------------------- -------------------
If you are considering developing a port for Solarized, please see also the If you are considering developing a port for Solarized, please see also the
[developer notes](http://ethanschoonover.com/solarized/DEVELOPERS) for [developer notes](http://ethanschoonover.com/solarized/DEVELOPERS) for
information about optional repository structure and readme formats. information about optional repository structure and readme formats.
Solarized flips between light and dark modes. In each mode, four monotones form Solarized flips between light and dark modes. In each mode, four monotones form
the core values (with an optional fifth for emphasized content). the core values (with an optional fifth for emphasized content).
![value samples - dark](https://github.com/altercation/solarized/raw/master/img/solarized-values-dark.png)\ ![value samples - dark](https://github.com/altercation/solarized/raw/master/img/solarized-values-dark.png)\
![value samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-values-light.png)\ ![value samples - light](https://github.com/altercation/solarized/raw/master/img/solarized-values-light.png)\
Thus in the case of a dark background colorscheme, the normal relationship for Thus in the case of a dark background colorscheme, the normal relationship for
background and body text is `base03:base0` (please note that body text is background and body text is `base03:base0` (please note that body text is
**not** `base00`). Note also that in cases where the background and foreground **not** `base00`). Note also that in cases where the background and foreground
can be specified as a pair value, text can be highlighted using a combination can be specified as a pair value, text can be highlighted using a combination
of `base02:base1`. The L\*a\*b lightness difference between `base03:base0` and of `base02:base1`. The L\*a\*b lightness difference between `base03:base0` and
`base02:base1` is identical by design, resulting in identical readability `base02:base1` is identical by design, resulting in identical readability
against both normal and highlighted backgrounds. An example use case is folded against both normal and highlighted backgrounds. An example use case is folded
text in Vim which uses `base02` for the background and `base1` for the text in Vim which uses `base02` for the background and `base1` for the
foreground. foreground.
The values in this example are simply inverted in the case of a light The values in this example are simply inverted in the case of a light
background. background.