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

3.8 KiB
Executable File

Conky

Build Status Quality Gate

Conky is a free, light-weight system monitor for X, that displays any kind of information on your desktop.

Grab the latest release from GitHub.

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 support, or any of your own scripts and programs ([more](Lua Interface)).
  • Built-in Imlib2 and Cairo bindings for arbitrary drawing with Lua (more).

... 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 screenshot screenshot

See the User Configs section of the wiki for more screenshots and their associated Conky config files.

Documentation

The GitHub Wiki serves as a central hub for all of Conky's documentation. Quick links:

License

Conky is licensed under the terms of the GPLv3 and BSD licenses.

Contributing

To submit code changes, please open pull requests against the GitHub repository. 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