Go to file
Nguyễn Gia Phong d35eeb2ed3 [docs] Move examples from README 2020-09-21 13:15:29 +07:00
contrib Correct the copyright headers in contrib 2019-09-18 10:26:23 +07:00
docs [docs] Move examples from README 2020-09-21 13:15:29 +07:00
templates Fix styling according to CONTRIBUTING.md 2019-10-17 21:26:06 +07:00
widgets [hwmontemp] Bring back sysfs path cache 2020-09-03 22:06:08 +07:00
.gitignore Draft Sphinx doc structure 2020-09-21 13:15:29 +07:00
.luacheckrc Add contributing guidelines and widget type templates 2019-10-17 21:26:06 +07:00
CONTRIBUTING.md Nitpick whitespace and bump version 2020-09-04 17:00:59 +07:00
Changes.md Nitpick whitespace and bump version 2020-09-04 17:00:59 +07:00
LICENSE Import of vicious source tree. 2009-07-29 17:59:32 +02:00
README.md [docs] Move examples from README 2020-09-21 13:15:29 +07:00
TODO Next release, tag 2.0.3 2011-05-10 22:40:34 +02:00
headergen Fix styling according to CONTRIBUTING.md 2019-10-17 21:26:06 +07:00
helpers.lua Make helpers.sysctl_async cross-platform & let bat_openbsd use it (#93) 2019-10-17 21:30:00 +07:00
init.lua Nitpick whitespace and bump version 2020-09-04 17:00:59 +07:00
spawn.lua Update copyright notices in libraries with the help of an auto-generator 2019-09-05 10:48:50 +07:00

README.md

Vicious

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.

Vicious widget types are a framework for creating your own widgets. Vicious contains modules that gather data about your system, and a few awesome helper functions that make it easier to register timers, suspend widgets and so on. Vicious doesn't depend on any third party Lua libraries, but may depend on additional system utilities (see widget description).

Contributing

For details, see CONTRIBUTING.md. Vicious is licensed under GNU GPLv2+, which require all code within the package to be released under a compatible license. All contributors retain their copyright to their code, so please make sure you add your name to the header of every file you touch.

Copying

Vicious is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

Please refer to our documentation for the full list of authors.