README

   1 This is a lean and mean implementation of wmiirc in lua.  The goals of
   2 the project are:
   3   - be fast, small, and feature rich,
   4   - avoid threading and polling at costs, and
   5   - replicate the functionality of wmii+ruby.
   6
   7 More details on my blog:
   8  - see http://www.jukie.net/~bart/blog/wmiirc-in-lua
   9
  10 Requirements:
  11  - wmii, 3.5+ or whatever is in hg at the moment
  12  - libixp, latest
  13  - lua5.1
  14  - liblua5.1
  15  - liblua5.1-posix0
  16  - patience (no, it's not a package)
  17
  18 Installation instructions:
  19  - install lua5.1 liblua5.1-posix0
  20    - on Debian you can do this to install all of lua5.1:
  21
  22        apt-cache search lua5.1 | awk '/liblua5.1/ { print $1 }' \
  23        | xargs sudo apt-get install -y
  24
  25  - build an install wmii from mercurial (3.5 or newer), you will also
  26    need libixp:
  27
  28      hg clone http://www.suckless.org/hg.rc/libixp
  29      hg clone http://www.suckless.org/hg.rc/wmii
  30
  31  - install the wmiirc script:
  32
  33      make install
  34
  35  - make .xsession execute wmii
  36
  37 Note:
  38  - my configuration uses Mod4 (the Win key on PC keyboards) for
  39    switching between work spaces and retagging.  If your keyboard does
  40    not have a Win key, you can execute the xmodmaprc-mod4 from your
  41    xsession:
  42      xmodmaprc .wmii-3.5/xmodmaprc-mod4