Cosmetic: indent properly
[stack/conf/irssi-colors-solarized.git] / README.mkd
index cca1825..f9883b7 100644 (file)
@@ -5,6 +5,8 @@ Initially created by Huy Z \<huy-git-pub circled-a huyzing.com\>, this is a
 repository of themes for the [irssi] IRC chat client that support the
 [Solarized] color scheme.
 
+![Solarized Dark main screenshot](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-main-in-iTerm-solarized-dark.png)
+
 [irssi]:                http://www.irssi.org/
 [Solarized]:            http://ethanschoonover.com/solarized
 
@@ -36,7 +38,7 @@ This means that a Solarized terminal application loses the ability to bold text
 but gains 8 more Solarized colors.
 
 About half of the Solarized palette is reminiscent of the original ANSI
-colors, e.g. Solarized red is close to ANSI red (or more precisley, the
+colors, e.g. Solarized red is close to ANSI red (or more precisely, the
 general consensus of what ANSI red should look like).  But the rest of the
 Solarized colors do not correspond to any ANSI colors, e.g. there is no ANSI
 color that corresponds to Solarized orange or purple.
@@ -65,8 +67,8 @@ Solarized orange.
 So in order for irssi to display the Solarized palette, you have to set your
 Terminal emulator's color settings to the Solarized palette. The [Solarized
 repository] includes theme settings for some popular terminal emulators as
-well as Xdefaults; or you can download them from the official [Solarized
-homepage]. If you use the irssi themes *without* having changed your
+well as Xdefaults; or you can download them from the official [Solarized]
+homepage. If you use the irssi themes *without* having changed your
 emulator's palette, you will get a strange selection of colors that may be
 hard to read.
 
@@ -125,29 +127,31 @@ read.
 
 Thus, this theme has been designed with these 4 palettes in mind:
 
-- Solarized Dark: "universal" works best with this scheme
-- Solarized Light: "universal" works almost as well as Solarized Dark (you
-  probably won't notice the difference, but if you do, it could be optimized
-  slightly by switching the theme's use of some of the Solarized base colors)
-- Default dark-background terminal colors
-- Default light-background terminal colors
+-   Solarized Dark: "universal" works best with this scheme
+-   Solarized Light: "universal" works with this scheme almost as well as with
+    Solarized Dark (you probably won't notice the difference, but if you do, it
+    could be optimized slightly by switching the theme's use of some of the
+    Solarized base colors)
+-   Default dark-background terminal colors
+-   Default light-background terminal colors
 
 This theme was designed to be clean and functional, starting from the default
 theme distributed with irssi.  Colors are strictly used for functionality and
 the number of colors visible is minimized when possible. Colors were selected
 based on the characteristics of the text characters to be displayed:
 
-- Visibility generally follows importance, with an attempt to let unimportant
-  text fade into the background (which is not always possible when supporting
-  both dark and light backgrounds)
-- Loud colors are chosen to call attention to noteworthy messages
+-   Visibility generally follows importance, with an attempt to let unimportant
+    text fade into the background (which is not always possible when
+    simultaneously supporting dark and light backgrounds)
+-   Loud colors are chosen to call attention to noteworthy messages
 
 ### Supported Scripts ###
 
 The following third-party scripts are supported:
-- [adv\_windowlist.pl](http://anti.teamidiot.de/static/nei/*/Code/Irssi/)
-- [usercount.pl](http://scripts.irssi.org/html/usercount.pl.html)
-- [trackbar.pl](http://scripts.irssi.org/html/trackbar.pl.html)
+
+-   [adv\_windowlist.pl](http://anti.teamidiot.de/static/nei/*/Code/Irssi/)
+-   [usercount.pl](http://scripts.irssi.org/html/usercount.pl.html)
+-   [trackbar.pl](http://scripts.irssi.org/html/trackbar.pl.html)
 
 ### Screenshots ###
 
@@ -156,19 +160,19 @@ Click images to see screenshots.
 
 Solarized Dark (this example uses iTerm2 on OS X):
 
-[<img src="https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_dark-th.png">](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_dark.png)
+[![Solarized Dark](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_dark-th.png)](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized\_dark.png)
 
 Solarized Light (this example uses iTerm2 on OS X):
 
-[<img src="https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_light-th.png">](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_light.png)
+[![Solarized Light](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized_light-th.png)](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm2-solarized\_light.png)
 
 Default dark terminal colors (this example uses Apple's Terminal.app on OS X):
 
-[<img src="https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-Terminal.app-dark-th.png">](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-Terminal.app-dark.png)
+[![default dark](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-Terminal.app-dark-th.png)](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-Terminal.app-dark.png)
 
 Default light terminal colors (this example uses iTerm on OS X):
 
-[<img src="https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm-light-th.png">](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm-light.png)
+[![default light](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm-light-th.png)](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-irssi-in-iTerm-light.png)
 
 Downloads
 ---------
@@ -194,19 +198,28 @@ Installation
     Terminals" for an explanation.)
 
     1.  Make sure that bold text is displayed using bright colors. For example,
-        - For iTerm2 on OS X, this means that Text Preferences must have the `Draw
-          bold text in bright colors` checkbox *selected*.
-        - For Apple's Terminal.app on OS X, this means that Text Settings must
-          have the `Use bright colors for bold text` checkbox *selected*.
+        -   For iTerm2 on OS X, this means that Text Preferences must have the `Draw
+            bold text in bright colors` checkbox *selected*.
+        -   For Apple's Terminal.app on OS X, this means that Text Settings must
+            have the `Use bright colors for bold text` checkbox *selected*.
+
+    2.  It's recommended to turn off the display of bold typeface for bold
+        text.  For example,
+        -   For iTerm2 on OS X, this means that Text Preferences should have the
+            `Draw bold text in bold font` checkbox *unselected*.
+        -   For Apple's Terminal.app on OS X, this means that Text Settings
+            should have the `Use bold fonts` checkbox *unselected*.
+        -   For XTerm, this may mean setting the `font` and `boldFont` to be the
+            same in your .Xresources or .Xdefaults, e.g.:
 
-    2.  It's recommended to turn off the display of bold typeface for bold text.  For
-        example,
-        - For iTerm on OS X, this means that Text Preferences should have the
-          `Draw bold text in bold font` checkbox *unselected*.
-        - For Apple's Terminal.app on OS X, this means that Text Settings
-          should have the `Use bold fonts` checkbox *unselected*.
+                xterm*font: fixed
+                xterm*boldFont: fixed
 
-2.  Obtain solarized-universal.theme
+    Example: for iTerm2, these are the correct settings:
+
+    ![iTerm bold settings](https://github.com/huyz/irssi-colors-solarized/raw/master/img/screen-iTerm2-bold-options.png)
+
+2.  Obtain `solarized-universal.theme`
 
     a) Option A: Download `solarized-universal.theme` from [irssi-only repository]
        and place it in your `~/.irssi` directory
@@ -289,25 +302,3 @@ matched in sRGB space.
     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
     green     #859900  2/2 green     64 #5f8700 60 -20  65 133 153   0  68 100  60
-
-License
--------
-Copyright (c) 2011 Huy Z
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.