From 052d19e6bb7c2a9fe60f9056f10eb1bbace3de5f Mon Sep 17 00:00:00 2001 From: "Adrian C. (anrxc)" Date: Sat, 1 Jun 2013 00:09:51 +0200 Subject: [PATCH] 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 users. Lua is the best thing since sliced bread. --- README | 32 +++++++++++++++++++++++--------- contrib/README | 19 ++++++++++--------- 2 files changed, 33 insertions(+), 18 deletions(-) diff --git a/README b/README index 6d1104b..bf16d36 100644 --- a/README +++ b/README @@ -1,16 +1,16 @@ Vicious ------- -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: +Vicious is a modular widget library for window managers, but mostly +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 +types, a few of them rewritten, and a good number of new ones: - 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, -and a few helper functions that make it easier to register timers, -suspend widgets and so on. +and a few "awesome" helper functions that make it easier to register +timers, suspend widgets and so on. 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 @@ -24,8 +24,22 @@ are used instead, where available: Usage ----- -To use vicious move it to your awesome configuration directory in -$XDG_CONFIG_HOME (usually ~/.config): +When provided by an operating system package, or installed from source +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/ 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 - 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(