README.rdoc

   1 = An amazing widget manager for an awesome window manager
   2
   3 * Feeds information to statusbars in the {awesome window manager}[http://awesome.naquadah.org/]
   4 * Framework for creating widgets
   5 * Centralized configuration
   6
   7 Widgets included in the core:
   8
   9 *AcAdapter*:: AC adapter status
  10 *Alsa*:: Various data for the ALSA mixer
  11 *Battery*:: Remaining battery power in percentage
  12 *CpuInfo*:: CPU Information
  13 *CpuUsage*:: CPU usage
  14 *Clock*:: Displays date and time
  15 *File*:: Information for a file
  16 *FileSystem*:: Various filesystem information
  17 *Gmail*:: GMail checker
  18 *Moc*:: Music On Console status
  19 *Mpd*:: MPD Information
  20 *Maildir*:: Mail count in maildirs
  21 *Memory*:: Various memory related data
  22 *NetTraffic*:: Network traffic information
  23 *Noop*:: Does nothing
  24 *Pacman*:: Available upgrades in the Pacman package manager
  25 *Raggle*:: Unread posts in raggle
  26
  27 == Installation procedures
  28
  29 To install, see <tt>ruby setup.rb --help</tt>. Quick and dirty:
  30
  31   # ruby setup.rb all
  32
  33 If you wish to install with Rubygems, build the gempackage and install it locally.
  34
  35   % gem build amazing.gemspec
  36   # gem install amazing-0.1.gem
  37
  38 You can also install it remotely from the Rubyforge servers (not yet).
  39
  40   # gem install amazing
  41
  42 == Configuration
  43
  44 Configuration of amazing is {documented at the wiki}[http://github.com/dag/amazing/wikis/configuration].
  45
  46 == Git repositories
  47
  48 *GitHub*:: http://github.com/dag/amazing
  49 *Gitorious*:: http://gitorious.org/projects/amazing
  50
  51 == Copying
  52
  53   Copyright (C) 2008 Dag Odenhall <dag.odenhall@gmail.com>
  54   Licensed under the Academic Free License version 3.0
  55
  56 See link:files/COPYING.html for full legal text.