v.licheni.net / stack / conf / irssi-colors-solarized.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated email address
[stack/conf/irssi-colors-solarized.git] / README.mkd
diff --git a/README.mkd b/README.mkd
index 302780e..deff53b 100644 (file)
--- a/README.mkd
+++ b/README.mkd
@@ -1,7 +1,7 @@
 Solarized Color Theme for irssi
 ===============================
 
 Solarized Color Theme for irssi
 ===============================
 
-Initially created by Huy Z \<huy-git-pub circled-a huyzing.com\>, this is a
+Initially created by [huyz](https://github.com/huyz), this is a
 repository of themes for the [irssi] IRC chat client that support Ethan
 Schoonover’s [Solarized] color scheme.
 
 repository of themes for the [irssi] IRC chat client that support Ethan
 Schoonover’s [Solarized] color scheme.
 
@@ -27,15 +27,16 @@ you happen to find yourself on a terminal where the Solarized palette has not
 been set up, you won't have elements become invisible or incrediby hard to
 read.
 
 been set up, you won't have elements become invisible or incrediby hard to
 read.
 
-Thus, this theme has been designed with these 4 palettes in mind:
+Thus, this theme was designed with these 4 palettes in mind:
 
 
--   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
+-   Solarized Dark: the theme works best when the terminal emulator is
+    set to this scheme
+-   Solarized Light: the theme works, when the terminal emulator is set
+    to 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 terminal ANSI Colors with a dark background
+-   Default terminal ANSI Colors with a light background
 
 This theme was designed to be clean and functional, starting from the default
 theme distributed with irssi.  Colors are strictly used for functionality and
 
 This theme was designed to be clean and functional, starting from the default
 theme distributed with irssi.  Colors are strictly used for functionality and
@@ -83,10 +84,12 @@ If you have come across these themes via the [irssi-only repository] on github,
 you may want to check the main [Solarized repository] to see if there is an
 official theme.
 
 you may want to check the main [Solarized repository] to see if there is an
 official theme.
 
-At some point, the [irssi-only repository] may be kept in sync with the main
-[Solarized repository] and would then only be preserved separately for
-installation convenience only. At this time, issues, bug reports, changelogs
-are to be reported at the [irssi-only repository].
+In the future, the [irssi-only repository] may be kept in sync with the main
+[Solarized repository], but the [irssi-only repository] may be left separate
+for installation convenience and to include the latest improvements.
+
+At this time, issues, bug reports, changelogs are to be reported at the
+[irssi-only repository].
 
 [Solarized repository]:  https://github.com/altercation/solarized
 [irssi-only repository]: https://github.com/huyz/irssi-colors-solarized
 
 [Solarized repository]:  https://github.com/altercation/solarized
 [irssi-only repository]: https://github.com/huyz/irssi-colors-solarized
@@ -95,17 +98,19 @@ are to be reported at the [irssi-only repository].
 Installation
 ------------
 
 Installation
 ------------
 
-1.  Make sure that you have changed your terminal emulator's color settings to
-    the Solarized palette.  (See the section "Understanding Solarized Colors in
-    Terminals" for an explanation.)
+1.  Configure your terminal emulator (See the section "Understanding Solarized Colors in
+    Terminals" for a detailed explanation behind these settings)
+
+    1.  Make sure that you have changed your terminal emulator's color settings to
+        the Solarized palette.
 
 
-    1.  Make sure that bold text is displayed using bright colors. For example,
+    2.  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
+    3.  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*.
         text.  For example,
         -   For iTerm2 on OS X, this means that Text Preferences should have the
             `Draw bold text in bold font` checkbox *unselected*.
@@ -228,7 +233,7 @@ 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
 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]
+well as Xresources; 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.
 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.