Use less threads, they're expensive [#9 state:closed]
[amazing.git] / README.rdoc
blobfc57fff9d38a04e5d2811a998fe2c354ab70618e
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 *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
28 == Installation procedures
30 To install, see <tt>ruby setup.rb --help</tt>. Quick and dirty:
32   # ruby setup.rb all
34 If you wish to install with Rubygems, build the gempackage and install it locally.
36   % gem build amazing.gemspec
37   # gem install amazing-0.1.gem
39 You can also install it remotely from the Rubyforge servers (not yet).
41   # gem install amazing
43 == Configuration
45 Configuration of amazing is {documented at the wiki}[http://github.com/dag/amazing/wikis/configuration].
47 == Git repositories
49 *GitHub*:: http://github.com/dag/amazing
50 *Gitorious*:: http://gitorious.org/projects/amazing
52 == Mail list
54 <b>amazing-talk</b>:: http://groups.google.com/group/amazing-talk
56 == Issues
57 *Lighthouse*:: http://amazing.lighthouseapp.com
59 == Copying
61 Copyright 2008 Dag Odenhall <dag.odenhall@gmail.com>
63 Licensed under the Apache License, Version 2.0 (the "License").
64 You may obtain a copy of the License at
66    http://www.apache.org/licenses/LICENSE-2.0
68 Unless required by applicable law or agreed to in writing, software
69 distributed under the License is distributed on an "AS IS" BASIS,
70 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71 See the License for the specific language governing permissions and
72 limitations under the License.