Website stuff
[amazing.git] / README.rdoc
blob8cf24c1c09ac1e34fb505eda5bc24bfcf86bc4f4
1 = An amazing widget manager for an awesome window manager
3 * Feeds information to statusbars in the {awesome window manager}[http://awesome.naquadah.org/]
4 * Framework for creating widgets
5 * Centralized configuration
7 Widgets included in the core:
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 *Pacman*:: Available upgrades in the Pacman package manager
24 *Raggle*:: Unread posts in raggle
26 == Installation procedures
28 To install, see <tt>ruby setup.rb --help</tt>. Quick and dirty:
30   # ruby setup.rb all
32 If you wish to install with Rubygems, build the gempackage and install it locally.
34   % gem build amazing.gemspec
35   # gem install amazing-0.1.gem
37 You can also install it remotely from the Rubyforge servers (not yet).
39   # gem install amazing
41 == Configuration
43 Configuration of amazing is {documented at the wiki}[http://github.com/dag/amazing/wikis/configuration].
45 == Git repositories
47 *GitHub*:: http://github.com/dag/amazing
48 *Gitorious*:: http://gitorious.org/projects/amazing
50 == Copying
52   Copyright (C) 2008 Dag Odenhall <dag.odenhall@gmail.com>
53   Licensed under the Academic Free License version 3.0
55 See link:files/COPYING.html for full legal text.