mirror of
https://github.com/altercation/solarized
synced 2024-11-21 19:23:02 +00:00
updated readmes and util scripts for release packaging
This commit is contained in:
parent
f792558e2e
commit
90581c7bfb
15 changed files with 97 additions and 39 deletions
74
README.md
74
README.md
|
@ -5,26 +5,25 @@ Solarized
|
||||||
|
|
||||||
## Precision colors for machines and people
|
## Precision colors for machines and people
|
||||||
|
|
||||||
[![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
|
Solarized is a sixteen color palette (eight monotones, eight accent colors)
|
||||||
color palette (eight monotones, eight accent colors) designed for use with
|
designed for use with terminal and gui applications. It has several [unique
|
||||||
terminal and gui applications. It has several [unique properties](#features).
|
properties](#features). I designed this colorscheme with both precise
|
||||||
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.
|
||||||
|
|
||||||
![solarized palette](https://github.com/altercation/solarized/raw/master/img/solarized-palette.png)
|
![solarized palette](https://github.com/altercation/solarized/raw/master/img/solarized-palette.png)\
|
||||||
|
|
||||||
Currently available in formats for (cf [screenshots](#screenshots) below):
|
Currently available in formats for (cf [screenshots](#screenshots) below):
|
||||||
|
|
||||||
* **Vim** (the Vim-only portion of Solarized is [available
|
* **Vim** (the Vim-only portion of Solarized is [available
|
||||||
here](https://github.com/altercation/vim-colors-solarized), for use with
|
here](https://github.com/altercation/vim-colors-solarized), for use with
|
||||||
Pathogen, etc.)
|
Pathogen, etc.)
|
||||||
* **Mutt** e-mail client (*just* the Mutt colorscheme is [available
|
* **Mutt** e-mail client (*just* the Mutt colorscheme is [available
|
||||||
here](https://github.com/altercation/mutt-colors-solarized))
|
here](https://github.com/altercation/mutt-colors-solarized))
|
||||||
* **Xresources** / Xdefaults
|
* **Xresources** / Xdefaults
|
||||||
|
@ -35,7 +34,7 @@ here](https://github.com/altercation/mutt-colors-solarized))
|
||||||
* 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.
|
happily note the contribution and include it on this page.
|
||||||
|
|
||||||
**Note:** I am still tweaking the Vim highlighting for specific syntaxes and
|
**Note:** I am still tweaking the Vim highlighting for specific syntaxes and
|
||||||
|
@ -44,14 +43,14 @@ welcome feedback on these.
|
||||||
Download
|
Download
|
||||||
--------
|
--------
|
||||||
|
|
||||||
### [Click here to download latest version](http://ethanschoonover.com/solarized/files/solarized.tgz)
|
### [Click here to download latest version](http://ethanschoonover.com/files/solarized/solarized.tar.gz)
|
||||||
|
|
||||||
Or use the following links to access application specific downloads and git
|
Or use the following links to access application specific downloads and git
|
||||||
repositories:
|
repositories:
|
||||||
|
|
||||||
* **Git repo:**
|
* **Git repo:**
|
||||||
|
|
||||||
The full git repository is at: <https://github.com/altercation/solarized>.
|
The full git repository is at: <https://github.com/altercation/solarized>
|
||||||
Get it using the following command:
|
Get it using the following command:
|
||||||
|
|
||||||
$ git clone git://github.com/altercation/solarized.git
|
$ git clone git://github.com/altercation/solarized.git
|
||||||
|
@ -60,10 +59,10 @@ repositories:
|
||||||
|
|
||||||
The vim-only colorscheme (Pathogen ready) is available at:
|
The vim-only colorscheme (Pathogen ready) is available at:
|
||||||
<https://github.com/altercation/vim-colors-solarized>.
|
<https://github.com/altercation/vim-colors-solarized>.
|
||||||
|
|
||||||
$ git clone git://github.com/altercation/vim-colors-solarized.git
|
|
||||||
|
|
||||||
You can also download it from [vim.org](http://vim.org/scripturlhere).
|
$ git clone git://github.com/altercation/vim-colors-solarized.git
|
||||||
|
|
||||||
|
You can also download it from [vim.org](http://www.vim.org/scripts/script.php?script_id=3520).
|
||||||
|
|
||||||
* **Mutt only:**
|
* **Mutt only:**
|
||||||
|
|
||||||
|
@ -95,7 +94,7 @@ Features
|
||||||
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)
|
||||||
|
@ -103,7 +102,7 @@ Features
|
||||||
|
|
||||||
2. **Both sides of the force**
|
2. **Both sides of the force**
|
||||||
|
|
||||||
![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
|
||||||
|
@ -113,7 +112,7 @@ Features
|
||||||
|
|
||||||
3. **16/5 palette modes**
|
3. **16/5 palette modes**
|
||||||
|
|
||||||
![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 carefull
|
terminal based applications / emulators. In addition, it has been carefull
|
||||||
|
@ -123,7 +122,7 @@ Features
|
||||||
|
|
||||||
5. **Precision, symmetry**
|
5. **Precision, symmetry**
|
||||||
|
|
||||||
![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
|
||||||
|
@ -204,51 +203,51 @@ Click to view.
|
||||||
|
|
||||||
### C (Vim)
|
### C (Vim)
|
||||||
|
|
||||||
[![c dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-lettergothic18-dark.png)
|
[![c dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-dark.png)
|
||||||
[![c light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-lettergothic18-light.png)
|
[![c light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-c-light.png)
|
||||||
|
|
||||||
### Haskell (Vim)
|
### Haskell (Vim)
|
||||||
|
|
||||||
[![haskell dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-lettergothic18-dark.png)
|
[![haskell dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-dark.png)
|
||||||
[![haskell light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-lettergothic18-light.png)
|
[![haskell light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-haskell-light.png)
|
||||||
|
|
||||||
### HTML (Vim)
|
### HTML (Vim)
|
||||||
|
|
||||||
[![html dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-lettergothic18-dark.png)
|
[![html dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-dark.png)
|
||||||
[![html light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-lettergothic18-light.png)
|
[![html light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-html-light.png)
|
||||||
|
|
||||||
### Java (Vim)
|
### Java (Vim)
|
||||||
|
|
||||||
[![java dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-lettergothic18-dark.png)
|
[![java dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-dark.png)
|
||||||
[![java light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-lettergothic18-light.png)
|
[![java light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-java-light.png)
|
||||||
|
|
||||||
### Pandoc (Vim)
|
### Pandoc Markdown (Vim)
|
||||||
|
|
||||||
These screen shots show Vim running with my own [Pandoc Kit
|
These screen shots show Vim running with my own [Pandoc Kit
|
||||||
Syntax](/pandockit).
|
Syntax](/pandockit).
|
||||||
|
|
||||||
[![pandoc dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-lettergothic18-dark.png)
|
[![pandoc dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-dark.png)
|
||||||
[![pandoc light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-lettergothic18-light.png)
|
[![pandoc light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-pandoc-light.png)
|
||||||
|
|
||||||
### Perl (Vim)
|
### Perl (Vim)
|
||||||
|
|
||||||
[![perl dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-lettergothic18-dark.png)
|
[![perl dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-dark.png)
|
||||||
[![perl light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-lettergothic18-light.png)
|
[![perl light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-perl-light.png)
|
||||||
|
|
||||||
### Python (Vim)
|
### Python (Vim)
|
||||||
|
|
||||||
[![python dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-lettergothic18-dark.png)
|
[![python dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-dark.png)
|
||||||
[![python light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-lettergothic18-light.png)
|
[![python light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-python-light.png)
|
||||||
|
|
||||||
### Ruby (Vim)
|
### Ruby (Vim)
|
||||||
|
|
||||||
[![ruby dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-lettergothic18-dark.png)
|
[![ruby dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-dark.png)
|
||||||
[![ruby light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-lettergothic18-light.png)
|
[![ruby light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-ruby-light.png)
|
||||||
|
|
||||||
### TeX (Vim)
|
### TeX (Vim)
|
||||||
|
|
||||||
[![tex dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-lettergothic18-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-lettergothic18-dark.png)
|
[![tex dark](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-dark-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-dark.png)
|
||||||
[![tex light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-lettergothic18-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-lettergothic18-light.png)
|
[![tex light](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-light-th.png)](https://github.com/altercation/solarized/raw/master/img/solarized-screen-tex-light.png)
|
||||||
|
|
||||||
|
|
||||||
The Values
|
The Values
|
||||||
|
@ -275,3 +274,4 @@ matched in sRGB space.
|
||||||
blue #268bd2 4/4 blue 33 #0087ff 55 -10 -45 38 139 210 205 82 82
|
blue #268bd2 4/4 blue 33 #0087ff 55 -10 -45 38 139 210 205 82 82
|
||||||
cyan #2aa198 6/6 cyan 37 #00afaf 60 -35 -05 42 161 152 175 74 63
|
cyan #2aa198 6/6 cyan 37 #00afaf 60 -35 -05 42 161 152 175 74 63
|
||||||
green #859900 2/2 green 64 #5f8700 60 -20 65 133 153 0 68 100 60
|
green #859900 2/2 green 64 #5f8700 60 -20 65 133 153 0 68 100 60
|
||||||
|
|
||||||
|
|
|
@ -31,6 +31,11 @@ Installation
|
||||||
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-dark-256.muttrc
|
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-dark-256.muttrc
|
||||||
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-light-256.muttrc
|
source $MAILCONF/mutt-colors-solarized/mutt-colors-solarized-light-256.muttrc
|
||||||
|
|
||||||
|
Note: You can safely ignore the compile colors script and the template file.
|
||||||
|
They are used only for creating the actual colorscheme files. If you want to
|
||||||
|
modify the colorscheme or colors, you can use the compile script and template
|
||||||
|
to do so.
|
||||||
|
|
||||||
Which Variation?
|
Which Variation?
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|
2
utils/README.md
Normal file
2
utils/README.md
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
These are used only for testing and packaging Solarized into release formats.
|
||||||
|
Disregard unless you are into ugly ex and quick and dirty shell scripts.
|
|
@ -10,7 +10,26 @@ rm **/*.un~
|
||||||
rm -rf img
|
rm -rf img
|
||||||
rm -rf tests
|
rm -rf tests
|
||||||
rm -rf utils
|
rm -rf utils
|
||||||
cd ..
|
|
||||||
gnutar -czvf solarized.tar.gz solarized
|
mkdir ~/tmp/solarized-packaged
|
||||||
|
|
||||||
|
cd ~/tmp
|
||||||
|
gnutar -czvf ~/tmp/solarized-packaged/solarized.tar.gz solarized
|
||||||
|
zip -rvX ~/tmp/solarized-packaged/solarized.zip solarized
|
||||||
|
cp ~/tmp/solarized-packaged/solarized.tar.gz ~/tmp/solarized-packaged/solarized-$1.tar.gz
|
||||||
|
cp ~/tmp/solarized-packaged/solarized.zip ~/tmp/solarized-packaged/solarized-$1.zip
|
||||||
|
|
||||||
|
cd ~/tmp/solarized
|
||||||
|
gnutar -czvf ~/tmp/solarized-packaged/vim-colors-solarized.tar.gz vim-colors-solarized
|
||||||
|
gnutar -czvf ~/tmp/solarized-packaged/mutt-colors-solarized.tar.gz mutt-colors-solarized
|
||||||
|
zip -rvX ~/tmp/solarized-packaged/vim-colors-solarized.zip vim-colors-solarized
|
||||||
|
zip -rvX ~/tmp/solarized-packaged/mutt-colors-solarized.zip mutt-colors-solarized
|
||||||
|
|
||||||
|
cp ~/tmp/solarized-packaged/vim-colors-solarized.tar.gz ~/tmp/solarized-packaged/vim-colors-solarized-$1.tar.gz
|
||||||
|
cp ~/tmp/solarized-packaged/mutt-colors-solarized.tar.gz ~/tmp/solarized-packaged/mutt-colors-solarized-$1.tar.gz
|
||||||
|
cp ~/tmp/solarized-packaged/vim-colors-solarized.zip ~/tmp/solarized-packaged/vim-colors-solarized-$1.zip
|
||||||
|
cp ~/tmp/solarized-packaged/mutt-colors-solarized.zip ~/tmp/solarized-packaged/mutt-colors-solarized-$1.zip
|
||||||
|
|
||||||
|
cd ~/tmp
|
||||||
rm -rf solarized
|
rm -rf solarized
|
||||||
|
|
||||||
|
|
4
utils/pandoc2readme
Normal file
4
utils/pandoc2readme
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
%s+(/img/solarized/+(https://github.com/altercation/solarized/raw/master/img/+g
|
||||||
|
g/\%^---/,/^---\s*$/d
|
||||||
|
g/\%^$/d
|
||||||
|
g/^The Values$/+6,/\%$/ s /^/ /
|
28
utils/vimorg-text
Normal file
28
utils/vimorg-text
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
Solarized
|
||||||
|
=========
|
||||||
|
|
||||||
|
summary
|
||||||
|
-------
|
||||||
|
|
||||||
|
Beautiful dual light/dark, selective contrast, GUI/256/16 colorscheme
|
||||||
|
|
||||||
|
detailed description
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Screenshots and details at http://ethanschoonover.com/solarized (includes Solarized for other applications including mutt, terminal emulators).
|
||||||
|
|
||||||
|
Can also be cloned from github at https://github.com/altercation/vim-colors-solarized for use with Pathogen, Vundle, etc.
|
||||||
|
|
||||||
|
* * *
|
||||||
|
|
||||||
|
Solarized is a beautiful, carefully designed 16 color, selective contrast colorscheme with both *light* and *dark* modes. It supports GUI full color, 256 color terminal mode and 16 color terminal mode (use Solarized terminal colorschemes with the latter for optimal results; see project homepage above).
|
||||||
|
|
||||||
|
It has been built on a foundation of eight monotones with precise CIELAB lightness relations. These monotones relations are symmetric, allowing for use in light and dark modes with identical readability.
|
||||||
|
|
||||||
|
Install details
|
||||||
|
---------------
|
||||||
|
|
||||||
|
See the README in the script download for installation details and utility scripts for your .vimrc.
|
||||||
|
|
||||||
|
For the impatient without customized vim setups: drop solarized.vim into your ~/.vim/colors directory.
|
||||||
|
|
Loading…
Reference in a new issue