1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-06-02 07:20:47 +00:00
conky/README.md

64 lines
2.8 KiB
Markdown
Raw Normal View History

2012-12-26 00:57:10 +00:00
## Conky
2012-12-26 20:49:31 +00:00
[![Build Status](https://travis-ci.org/brndnmtthws/conky.png)](https://travis-ci.org/brndnmtthws/conky)
2012-12-26 00:57:10 +00:00
**Conky** is a free, light-weight system monitor for X, that displays
any kind of information on your desktop.
### Features
Conky can display more than 300 built-in objects, including support for:
* A plethora of OS stats (uname, uptime, **CPU usage**, **mem
usage**, disk usage, **"top"** like process stats, and **network
monitoring**, just to name a few).
* Built-in **IMAP** and **POP3** support.
* Built-in support for many popular music players ([MPD][],
[XMMS2][], [BMPx][], [Audacious][]).
* Can be extended using built-in [**Lua**](lua) support, or any of your
own scripts and programs ([more](Lua Interface)).
* Built-in [**Imlib2**][Imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
with Lua ([more](wiki/Lua-Interface)).
... and much much more.
Conky can display information either as text, or using simple progress
bars and graph widgets, with different fonts and colours.
### Screenshots
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/brenden/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/ke49/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/jc/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
2012-12-26 00:57:10 +00:00
See the [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs) section of the wiki for more
2013-09-13 20:49:55 +00:00
screenshots and their associated Conky config files.
2012-12-26 00:57:10 +00:00
### Documentation
2013-09-13 20:49:55 +00:00
The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of
2012-12-26 00:57:10 +00:00
Conky's documentation. Quick links:
* [Install](https://github.com/brndnmtthws/conky/wiki/Installation)
* [Configure](https://github.com/brndnmtthws/conky/wiki/Configure)
* [User Configs](https://github.com/brndnmtthws/conky/wiki/User-Configs)
* [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
2012-12-26 00:57:10 +00:00
### License
Conky is licensed under the terms of the [GPLv3](LICENSE.GPL) and
[BSD](LICENSE.BSD) licenses.
2012-12-26 00:57:10 +00:00
[MPD]: http://musicpd.org/
[XMMS2]: http://wiki.xmms2.xmms.se/index.php/Main_Page
[BMPx]: http://bmpx.backtrace.info/site/BMPx_Homepage
[Audacious]: http://audacious-media-player.org/
[luawiki]: http://en.wikipedia.org/wiki/Lua_%28programming_language%29
2012-12-26 20:49:31 +00:00
[stable-src]: https://github.com/brndnmtthws/conky/archive/1.9.0.tar.gz
[devel-src]: https://github.com/brndnmtthws/conky/archive/master.tar.gz
[wiki]: https://github.com/brndnmtthws/conky/wiki
2012-12-26 00:57:10 +00:00
[lists]: http://sourceforge.net/mail/?group_id=143975
[ircconky]: irc://irc.freenode.net/conky
[Imlib2]: http://docs.enlightenment.org/api/imlib2/html/
[cairo]: http://www.cairographics.org/