README: explain vicious is a generic WM widget library

Vicious can be used stand-alone, or to feed widgets in window managers
beside awesome. So why not provide it to a few Ion, or WMII, or i3 or
<foobar> users. Lua is the best thing since sliced bread.
This commit is contained in:
Adrian C. (anrxc) 2013-06-01 00:09:51 +02:00
parent bb891d66e4
commit 052d19e6bb
2 changed files with 33 additions and 18 deletions

32
README
View File

@ -1,16 +1,16 @@
Vicious Vicious
------- -------
Vicious is a modular widget library for the "awesome" window manager, Vicious is a modular widget library for window managers, but mostly
derived from the "Wicked" widget library. It has some of the old catering to users of the "awesome" window manager. It was derived from
Wicked widget types, a few of them rewritten, and a good number of new the old "Wicked" widget library, and has some of the old Wicked widget
ones: types, a few of them rewritten, and a good number of new ones:
- http://git.sysphere.org/vicious/about/ - http://git.sysphere.org/vicious/about/
Vicious widget types are a framework for creating your own awesome Vicious widget types are a framework for creating your own
widgets. Vicious contains modules that gather data about your system, widgets. Vicious contains modules that gather data about your system,
and a few helper functions that make it easier to register timers, and a few "awesome" helper functions that make it easier to register
suspend widgets and so on. timers, suspend widgets and so on.
For now Vicious doesn't depend on any third party Lua libraries, to For now Vicious doesn't depend on any third party Lua libraries, to
make it easier to install and use. That means some system utilities make it easier to install and use. That means some system utilities
@ -24,8 +24,22 @@ are used instead, where available:
Usage Usage
----- -----
To use vicious move it to your awesome configuration directory in When provided by an operating system package, or installed from source
$XDG_CONFIG_HOME (usually ~/.config): into the Lua library path Vicious can be used as a regular Lua
library, to be used stand-alone or to feed widgets of any window
manager (ie. Ion, WMII). It is compatible with both Lua v5.1 and v5.2.
$ lua
> widgets = require("vicious.widgets")
> print(widgets.volume(nil, "Master")[1])
100
Usage within Awesome
--------------------
To use Vicious with Awesome, install the package from your operating
system provider, or download the source code and move it to your
awesome configuration directory in $XDG_CONFIG_HOME (usually ~/.config):
$ mv vicious $XDG_CONFIG_HOME/awesome/ $ mv vicious $XDG_CONFIG_HOME/awesome/

View File

@ -1,14 +1,14 @@
Contrib Contrib
------- -------
Contrib widgets are extra widgets you can use. Some are for less Contrib libraries, or widget types, are extra snippets of code you can
common hardware, and other were contributed by Vicious users. The use. Some are for less common hardware, and other were contributed by
contrib directory also holds widget types that were obsoleted or Vicious users. The contrib directory also holds widget types that were
rewritten. Contrib widgets will not be imported by init unless you obsoleted or rewritten. Contrib widgets will not be imported by init
explicitly enable it, or load them in your rc.lua. unless you explicitly enable it, or load them in your rc.lua.
Usage Usage within Awesome
----- --------------------
To use contrib widgets uncomment the line that loads them in To use contrib widgets uncomment the line that loads them in
init.lua. Or you can load them in your rc.lua after you require init.lua. Or you can load them in your rc.lua after you require
Vicious: Vicious:
@ -92,8 +92,9 @@ vicious.contrib.buildbot
- <buildNumber> colors: red - failed, green - successful, yellow - in progress - <buildNumber> colors: red - failed, green - successful, yellow - in progress
- it depends on lua json parser (e.g. liblua5.1-json on Ubuntu 12.04) - it depends on lua json parser (e.g. liblua5.1-json on Ubuntu 12.04)
Usage examples
-------------- Usage examples (for awesome v3.4)
---------------------------------
Pulse Audio widget Pulse Audio widget
vicious.register(vol, vicious.contrib.pulse, " $1%", 2, "alsa_output.pci-0000_00_1b.0.analog-stereo") vicious.register(vol, vicious.contrib.pulse, " $1%", 2, "alsa_output.pci-0000_00_1b.0.analog-stereo")
vol:buttons(awful.util.table.join( vol:buttons(awful.util.table.join(