2018-10-21 10:49:31 +02:00
|
|
|
# Vicious
|
|
|
|
|
|
2014-01-01 13:47:29 +01:00
|
|
|
Vicious is a modular widget library for window managers, but mostly
|
2018-10-21 10:49:31 +02:00
|
|
|
catering to users of the *awesome* window manager. It was derived from
|
|
|
|
|
the old *Wicked* widget library, and has some of the old *Wicked* widget
|
2019-09-18 10:52:45 +02:00
|
|
|
types, a few of them rewritten, and a good number of new ones.
|
2011-11-27 13:42:43 +01:00
|
|
|
|
2014-01-01 13:47:29 +01:00
|
|
|
Vicious widget types are a framework for creating your own
|
2011-11-27 13:42:43 +01:00
|
|
|
widgets. Vicious contains modules that gather data about your system,
|
2018-10-21 10:49:31 +02:00
|
|
|
and a few *awesome* helper functions that make it easier to register
|
2017-01-25 18:01:08 +01:00
|
|
|
timers, suspend widgets and so on. Vicious doesn't depend on any third party
|
|
|
|
|
Lua libraries, but may depend on additional system utilities (see widget
|
|
|
|
|
description).
|
2011-11-27 13:42:43 +01:00
|
|
|
|
2020-09-13 12:35:11 +02:00
|
|
|
## Usage
|
2019-10-16 09:42:31 +02:00
|
|
|
|
2020-09-13 12:35:11 +02:00
|
|
|
Please see our [online documentation] for detail instructions.
|
|
|
|
|
It is also available under the `docs` directory for offline reference.
|
2019-10-16 09:42:31 +02:00
|
|
|
|
2020-09-07 15:43:25 +02:00
|
|
|
## Copying
|
|
|
|
|
|
|
|
|
|
Vicious is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 2 of the
|
|
|
|
|
License, or (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
Please refer to our documentation for the full [list of authors].
|
|
|
|
|
|
2020-09-13 12:35:11 +02:00
|
|
|
[online documentation]: https://vicious.rtfd.io
|
2020-09-07 15:43:25 +02:00
|
|
|
[list of authors]: https://vicious.rtfd.io/copying.html
|
