summaryrefslogtreecommitdiffabout
About:
    Vicious is a modular widget library for the "awesome" window manager,
    derived from the 'Wicked' widget library. It has some of the old
    Wicked widget types, a few of them rewritten, and a good number of
    new ones.


Obtaining:
    Download the tarball of the latest tag, or get the development
    code with git. Git access is provided over http, you can clone the
    repo with:

    $ git clone http://git.sysphere.org/vicious


    awesome 3.3:
        Vicious tag v1.0.11 was the last release compatible with
        awesome versions prior to 3.4. However, bug fixes and
        improvements were backported and last recommended release to
        use with older awesome versions is v1.0.11.4.

    Wicked
        Switching from Wicked to Vicious is straightforward. There are
        small differences in the API:
        * Caching is entirely controlled by users.
        * Using a string widget type is not allowed.
        * Padding is not provided by vicious helpers.

    BSD
        Richard Kolkovich, a FreeBSD user, published his vicious-fbsd
        branch. You can find his work here:
        * http://git.sigil.org/vicious-fbsd/


Contributing:
    If you improved some code or solved a problem you can send me a
    patch by e-mail.


Summary:
    * Original code modularized
    * Widget types ported from Wicked:
      - CPU Usage, Date, File System, Memory, MPD, Network Usage
    * Widget types written for Vicious:
      - OS Information, CPU Information, CPU Frequency, Disk I/O, HDD
        Temperature, Mbox, Mbox Count, Maildir, Gmail, Org-Mode,
        Battery, Thermal, Volume, Weather, Wireless, Package Updates,
        System Uptime/Load


Vicious is licensed under the GNU General Public License version 2
    * Copyright (C) 2010, Adrian C. <anrxc sysphere.org>
    * Copyright (C) Wicked, Lucas de Vries <lucas glacicle.com>