wmii/alternative_wmiircs/ruby/README
2010-06-11 23:48:29 -04:00

94 lines
2.5 KiB
Plaintext

This is a modified version of sunaku's wmiirc, designed for
his Rumai Ruby module. Minor configuration changes, namely to
the color scheme and default key bindings, as well as the
configuration search path, exist in this version. Builtin mpd
support has also been removed. Also added is support for
string interpolation in key bindings, as should be apparent in
the included config.yaml.
In particular, not that there is no need to copy any files to
@LOCALCONF@ other than config.yaml. The script will happily load
the requisite files from their default install location. They
can be loaded either by involing wmii as follows:
wmiir -r ruby/wmiirc
or running the following after startup:
wmiir xwrite /ctl spawn ruby/wmiirc
The rumai gem is still required, as noted below.
The original readme appears below unmodified:
sunaku's Ruby wmiirc
====================
This is my wmii configuration, described in these articles:
http://wmii.suckless.org/alternative_wmiirc_scripts
http://snk.tuxfamily.org/lib/rumai/
http://article.gmane.org/gmane.comp.window-managers.wmii/1704
http://snk.tuxfamily.org/web/2006-07-01-wmii-3-1-configuration-in-ruby.html
Dependencies:
wmii 3.6 or newer (preferably wmii-hg)
Ruby 1.8.6 or newer
RubyGems 1.3.1 or newer
Installation:
# library
gem install rumai # required
gem install librmpd # optional
# install
mv @LOCALCONF@ @LOCALCONF@.backup
git clone git://github.com/sunaku/wmiirc.git @LOCALCONF@
# choose
cd @LOCALCONF@
git checkout --track -b CHOICE origin/CHOICE # choices are:
+--------+------------------------------------------------+
| CHOICE | DESCRIPTION |
+--------+------------------------------------------------+
| dvorak | sunaku's personal configuration; DSK friendly! |
| qwerty | QWERTY port of sunaku's personal configuration |
| strict | port of the default wmiirc shipped with wmii |
| master | barebones template for starting from scratch |
+--------+------------------------------------------------+
# run
@LOCALCONF@/wmiirc
Documentation:
# see list of all key bindings
egrep '^ +\$\{\w+\}' @LOCALCONF@/config.yaml
# read the configuration file
less @LOCALCONF@/config.yaml
Configuration:
Edit @LOCALCONF@/config.yaml to your liking.
Run @LOCALCONF@/wmiirc to apply your changes.
Contribution:
Fork this project on GitHub and send pull requests.
Questions:
Send me an e-mail (see LICENSE for my address).