doc/dir-structure

   1 This file describes the directory structure for ~/.wmii-3.5
   2
   3 ${HOME}/.wmii-3.5
   4         |--- wmiirc                     <-- configuration file
   5         |--- core
   6         |    |--- wmii.lua              <-- core lua bits
   7         |    `--- ixp.so                <-- core C bits
   8         `--- plugins
   9              |--- clock.lua             <-- lua-only plugin
  10              |--- foo.lua               <-- another plugin
  11              `--- foo_core.so           <-- support library for plugin
  12
  13 In 0.2 the plugin directory will be extended to allow for plugins to
  14 have their own directory and they will be loaded using
  15 wmii.load_plugin("name") and not require "name".
  16
  17 ${HOME}/.wmii-3.5
  18         ...
  19         ...
  20         `--- plugin
  21              |--- clock.lua             <-- single-file lua-only plugin
  22              `--- foo
  23                   |--- foo.lua          <-- main file to load
  24                   |--- bar.so           <-- support libraries
  25                   |--- biz.so
  26                   `--- data.file        <-- data file
  27
  28 vim: set ts=8 et sw=8 tw=72