Update README.md
This commit is contained in:
parent
9b943513d5
commit
f48d52b46c
31
README.md
31
README.md
@ -1,30 +1,3 @@
|
||||
# Vicious
|
||||
# My AwesomeWM configurations
|
||||
|
||||
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).
|
||||
|
||||
## Usage
|
||||
|
||||
Please see our [online documentation] for detail instructions.
|
||||
It is also available under the `docs` directory for offline reference.
|
||||
|
||||
## 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].
|
||||
|
||||
[online documentation]: https://vicious.rtfd.io
|
||||
[list of authors]: https://vicious.rtfd.io/copying.html
|
||||
### !!! any images found in this repository may be subject to licenses other than the GPL !!!
|
||||
|
Loading…
Reference in New Issue
Block a user