Go to file
Brenden Matthews e91b91d85a
Apply a bunch of code fixes from sonarcloud. (#492)
2018-05-13 09:58:03 -04:00
bin Only run tidy on modified code, relocate scripts. (#490) 2018-05-12 22:46:47 -04:00
cmake Only run tidy on modified code, relocate scripts. (#490) 2018-05-12 22:46:47 -04:00
data Only run tidy on modified code, relocate scripts. (#490) 2018-05-12 22:46:47 -04:00
doc Add formatting/static analysis (#486) 2018-05-12 12:03:00 -04:00
extras Basic macOS support (#480) 2018-05-07 07:27:32 -04:00
lua Add formatting/static analysis (#486) 2018-05-12 12:03:00 -04:00
src Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.clang-format Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.dockerignore Build improvements: clang-tidy, sonar, Dockerfile. (#488) 2018-05-12 19:26:31 -04:00
.editorconfig Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.gitignore Build improvements: clang-tidy, sonar, Dockerfile. (#488) 2018-05-12 19:26:31 -04:00
.travis.yml Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
AUTHORS Basic macOS support (#480) 2018-05-07 07:27:32 -04:00
CMakeLists.txt Build improvements: clang-tidy, sonar, Dockerfile. (#488) 2018-05-12 19:26:31 -04:00
COPYING Update COPYING 2018-01-25 09:28:24 -05:00
ChangeLog $memwithbuffers object and bar (sf.net #2954143) 2010-02-18 18:32:25 +01:00
Dockerfile Build improvements: clang-tidy, sonar, Dockerfile. (#488) 2018-05-12 19:26:31 -04:00
INSTALL Initial revision 2005-07-20 00:30:40 +00:00
LICENSE GPLv3 is the default license. 2018-01-25 09:26:33 -05:00
LICENSE.BSD Add formatting/static analysis (#486) 2018-05-12 12:03:00 -04:00
NEWS Reformatted all code 2008-02-20 20:30:45 +00:00
README.cmake Deprecate autotools, update docs to reflect cmake build system. 2010-01-01 14:08:57 -08:00
README.docker Using X11 conky in a container 2018-02-18 18:17:22 +01:00
README.md Only run tidy on modified code, relocate scripts. (#490) 2018-05-12 22:46:47 -04:00
TODO Removing old svn keywords. 2008-12-09 16:35:49 -07:00
sonar-project.properties Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
uncrustify.cfg Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00

README.md

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