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 *Sup*:: Mail count in sup for the specified search terms
  27
  28 == Installation procedures
  29
  30 To install, see <tt>ruby setup.rb --help</tt>. Quick and dirty:
  31
  32   # ruby setup.rb all
  33
  34 If you wish to install with Rubygems, build the gempackage and install it locally.
  35
  36   % gem build amazing.gemspec
  37   # gem install amazing-0.1.gem
  38
  39 You can also install it remotely from the Rubyforge servers (not yet).
  40
  41   # gem install amazing
  42
  43 == Configuration
  44
  45 Configuration of amazing is {documented at the wiki}[http://github.com/dag/amazing/wikis/configuration].
  46
  47 == Git repositories
  48
  49 *GitHub*:: http://github.com/dag/amazing
  50 *Gitorious*:: http://gitorious.org/projects/amazing
  51
  52 == Mail list
  53
  54 <b>amazing-talk</b>:: http://groups.google.com/group/amazing-talk
  55
  56 == Copying
  57
  58 Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
  59
  60 Licensed under the Apache License, Version 2.0 (the "License").
  61 You may obtain a copy of the License at
  62
  63    http://www.apache.org/licenses/LICENSE-2.0
  64
  65 Unless required by applicable law or agreed to in writing, software
  66 distributed under the License is distributed on an "AS IS" BASIS,
  67 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  68 See the License for the specific language governing permissions and
  69 limitations under the License.