contrib: document how to enable contributed widgets
This commit is contained in:
parent
e1c7c4772a
commit
3b161ffa28
3
README
3
README
|
@ -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
|
extra widgets you can use. Some are for less common hardware, and
|
||||||
other were contributed by Vicious users. The contrib directory also
|
other were contributed by Vicious users. The contrib directory also
|
||||||
holds widget types that were obsoleted or rewritten. Contrib widgets
|
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
|
Richard Kolkovich, a FreeBSD user, published his vicious-fbsd
|
||||||
branch. If you are also a BSD user you can find his work here:
|
branch. If you are also a BSD user you can find his work here:
|
||||||
|
|
|
@ -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
|
common hardware, and other were contributed by Vicious users. The
|
||||||
contrib directory also holds widget types that were obsoleted or
|
contrib directory also holds widget types that were obsoleted or
|
||||||
rewritten. Contrib widgets will not be imported by init unless you
|
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
|
Widget types
|
||||||
|
|
Loading…
Reference in New Issue