2012-12-26 00:57:10 +00:00
## Conky
2012-12-26 20:49:31 +00:00
[](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.
2015-11-18 15:47:45 +00:00
Grab the [latest release from GitHub ](https://github.com/brndnmtthws/conky/releases/latest ).
2012-12-26 00:57:10 +00:00
### 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
2016-06-24 14:20:39 +00:00
with Lua ([more](wiki/Lua-API)).
2012-12-26 00:57:10 +00:00
... 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
2013-03-28 21:29:47 +00:00
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
2012-12-26 00:57:10 +00:00
2013-03-28 21:29:47 +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:
2013-03-28 21:29:47 +00:00
* [Install ](https://github.com/brndnmtthws/conky/wiki/Installation )
2016-06-24 14:17:56 +00:00
* [Configure ](https://github.com/brndnmtthws/conky/wiki/Configuration-Settings )
2013-03-28 21:29:47 +00:00
* [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
2013-03-28 21:29:47 +00:00
Conky is licensed under the terms of the [GPLv3 ](LICENSE.GPL ) and
[BSD ](LICENSE.BSD ) licenses.
2012-12-26 00:57:10 +00:00
2016-07-13 14:29:51 +00:00
### Contributing
To submit code changes, please open pull requests against [the GitHub repository ](https://github.com/brndnmtthws/conky/edit/master/README.md ). Patches submitted in issues, email, or elsewhere will likely be ignored. Here's some general guidelines when submitting PRs:
* In your pull request, please:
* Describe the changes, why they were necessary, etc
* Describe how the changes affect existing behaviour
* Describe how you tested and validated your changes
* Include any relevant screenshots/evidence demonstrating that the changes work and have been tested
* Any new source files should include a GPLv3 license header
* Any contributed code must be GPLv3 licensed
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/
