Contents

%#--
%# Copyright protects this work.
%# See LICENSE file for details.
%#++

% api_url = './api/index.html'
% src_url = 'http://github.com/sunaku/' + $program
% src_scm = '[Git](http://git-scm.com)'


%|chapter "Introduction"


  %|project

    <%= $project %> is a [Ruby](<%= ruby_url %>) interface to the [wmii](<%= wmii_url %>) window manager.


  * <%= xref "History", "What's new?" %> --- history of project releases.
  * [Source code](<%= src_url %>) --- obtain via <%= src_scm %> or browse online.
  * [API reference](<%= api_url %>) --- documentation for source code.
  * [Project home](<%= $website %>) --- the <%= $project %> project home page.

  To get help or provide feedback, simply
  <%= xref "License", "contact the author(s)" %>.


  %|section "Features"

    <%= $project %> is exciting because:

    * It excels at dynamic arrangement of clients, columns, views, and tags.
    * It provides an <%= xref 'shell', 'interactive shell' %> for live entertainment and experimentation.
    * It provides a pure Ruby client for the [9P2000 protocol](<%= p9p_url %>), upon which wmii's [IXP file-system interface](<%= wmii_ixp_url %>) is built.


  %|section "Etymology"

    The word "wmii" is difficult to pronounce because it is an abbreviation, not an acronym.  If we were to treat it as an acronym, the closest pronounciation would be, in my mind, something like "vim-eye".

    Since this is a Ruby library, I added a "roo" and worked it through:

    * vim-eye
    * roo-vim-eye
    * roovm-eye

    And thus we get "Rumai".


  %|section "License"

    %< "../LICENSE"


  %|section "Credits"

    <%= $project %> is made possible by
    %= xref "History", "contributions"
    from users like you:

    %< "../CREDITS"


  %|section "Related works"

    * [r9p](http://libs.suckless.org/r9p)
    * [Rii](http://rubyforge.org/projects/rii/)
    * [Ruby-IXP](http://home.gna.org/rubyixp/)
    * [ruby-wmii](http://eigenclass.org/hiki.rb?wmii+ruby)

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rumai-3.2.0	doc/intro.erb
rumai-3.1.0	doc/intro.erb