wmiirc-rumai

commit 762169fa9f01749d1faf8a19e063a83333b5e70f
parent 253347d14c7965539448fed3678aad72214865ee
Author: Suraj N. Kurapati <sunaku@gmail.com>
Date:   Tue, 12 May 2009 01:09:09 -0700

clean up & revise docs

Diffstat:
README
 | 
13
+++++++------
config.rb
 | 
5
++++-
config.yaml
 | 
8
+++++++-

3 files changed, 18 insertions(+), 8 deletions(-)
diff --git a/README b/README
@@ -13,18 +13,19 @@ This is my wmii configuration, described in these articles:
 
 Dependencies:
 
+    wmii-3.6 or newer (preferably wmii-hg)
+
     Ruby 1.8.6 or newer
 
     RubyGems 1.3.1 or newer
 
-    wmii-3.6 or newer (preferably wmii-hg)
-
 Installation:
 
-    # required libraries
-    gem install rumai librmpd
+    # dependencies
+    gem install rumai     # required
+    gem install librmpd   # optional
 
-    # the wmiirc itself
+    # installation
     mv ~/.wmii-hg ~/.wmii-hg.backup
     git clone git://github.com/sunaku/wmiirc.git ~/.wmii-hg
 
@@ -38,7 +39,7 @@ Installation:
 Documentation:
 
     # see list of all key bindings
-    grep 'Mod1.*#' ~/.wmii-hg/config.yaml
+    grep 'Mod.*#' ~/.wmii-hg/config.yaml
 
     # read the configuration file
     less ~/.wmii-hg/config.yaml
diff --git a/config.rb b/config.rb
@@ -303,7 +303,10 @@ def load_config config_file
             # buttons are displayed in the ASCII order of their IXP file names
             file = [defn['position'], name].compact.join('-')
 
-            button = eval "Button.new(fs.rbar[#{file.inspect}], #{defn['refresh']}) { #{defn['content']} }", TOPLEVEL_BINDING, "#{config_file}:display:status:#{name}"
+            button = eval(
+              "Button.new(fs.rbar[#{file.inspect}], #{defn['refresh']}) { #{defn['content']} }",
+              TOPLEVEL_BINDING, "#{config_file}:display:status:#{name}"
+            )
 
             @status_button_by_name[name] = button
           end
diff --git a/config.yaml b/config.yaml
@@ -1,4 +1,10 @@
+#
 # High-level wmii configuration.
+#
+# Ruby code in this file has access
+# to a CONFIG constant which contains
+# the data in this configuration file.
+#
 #--
 # Copyright 2006 Suraj N. Kurapati
 # See the LICENSE file for details.
@@ -56,7 +62,7 @@ display:
   ##
   # Settings for columns drawn by wmii.
   #
-  #   mode: <the default column mode>
+  #   mode: <the wmii "colmode" setting>
   #   rule: <the wmii "colrules" setting>
   #
   column: