diff options
| author | Adrian C. (anrxc) <anrxc@sysphere.org> | 2012-06-25 01:22:53 +0200 |
|---|---|---|
| committer | Adrian C. (anrxc) <anrxc@sysphere.org> | 2012-06-25 01:22:53 +0200 |
| commit | 3b161ffa28e50d6674e081a2ee28c76b05d8b014 (patch) | |
| tree | 9ee669d5ff3210fbf542de7da8cf6f98d1c36527 | |
| parent | e1c7c4772a8c1c651964bbcfbcdc0dc5d47d6dc4 (diff) | |
| download | vicious-legacy-3b161ffa28e50d6674e081a2ee28c76b05d8b014.tar.xz | |
contrib: document how to enable contributed widgets
| -rw-r--r-- | README | 3 | ||||
| -rw-r--r-- | contrib/README | 12 |
2 files changed, 13 insertions, 2 deletions
@@ -291,7 +291,8 @@ in the contrib directory of Vicious. The contrib directory contains 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. +will not be imported by init unless you explicitly enable it, or load +them in your rc.lua. Richard Kolkovich, a FreeBSD user, published his vicious-fbsd branch. If you are also a BSD user you can find his work here: diff --git a/contrib/README b/contrib/README index 16716ac..0c1e55b 100644 --- a/contrib/README +++ b/contrib/README @@ -4,7 +4,17 @@ 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. +explicitly enable it, or load them in your rc.lua. + + +Usage +----- +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: + + local vicious = require("vicious") + vicious.contrib = require("vicious.contrib") Widget types |