diff options
| author | Adrian C. (anrxc) <anrxc@sysphere.org> | 2013-06-01 00:09:51 +0200 |
|---|---|---|
| committer | Adrian C. (anrxc) <anrxc@sysphere.org> | 2013-06-01 00:09:51 +0200 |
| commit | 052d19e6bb7c2a9fe60f9056f10eb1bbace3de5f (patch) | |
| tree | 998a47014925b93a47d99a2a8f9823c167a83511 /contrib | |
| parent | bb891d66e4834c66494e12bdc3c2896e5f13c292 (diff) | |
| download | vicious-legacy-052d19e6bb7c2a9fe60f9056f10eb1bbace3de5f.tar.xz | |
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.
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/README | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/contrib/README b/contrib/README index 665592e..7d2d08c 100644 --- a/contrib/README +++ b/contrib/README @@ -1,14 +1,14 @@ Contrib ------- -Contrib widgets are extra widgets you can use. Some are for less -common hardware, and other were contributed by Vicious users. The -contrib directory also holds widget types that were obsoleted or -rewritten. Contrib widgets will not be imported by init unless you -explicitly enable it, or load them in your rc.lua. +Contrib libraries, or widget types, are extra snippets of code you can +use. Some are for less common hardware, and other were contributed by +Vicious users. The contrib directory also holds widget types that were +obsoleted or rewritten. Contrib widgets will not be imported by init +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 init.lua. Or you can load them in your rc.lua after you require Vicious: @@ -92,8 +92,9 @@ vicious.contrib.buildbot - <buildNumber> colors: red - failed, green - successful, yellow - in progress - 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 vicious.register(vol, vicious.contrib.pulse, " $1%", 2, "alsa_output.pci-0000_00_1b.0.analog-stereo") vol:buttons(awful.util.table.join( |