Go to file
Brenden Matthews c1059030cf
Fix platform checks for libxml2. (#687)
Use the CMake module for finding libxml2, instead of relying on
pkg-config which may break on some platforms like macOS.
2018-12-02 13:26:02 -05:00
bin Only run tidy on modified code, relocate scripts. (#490) 2018-05-12 22:46:47 -04:00
cmake Fix platform checks for libxml2. (#687) 2018-12-02 13:26:02 -05:00
data Conky for mac os master (#579) 2018-08-07 11:54:01 -04:00
doc Add config option to disable blending (#682) 2018-12-02 11:29:33 -05:00
extras add memwithbuffersgraph variable (#671) 2018-10-21 15:52:15 +03:00
logo Bump up png logo resolutions. (#634) 2018-08-20 07:51:40 -04:00
lua Fix problems found when fixing docker (#575) 2018-08-07 09:38:36 -04:00
src When compiling with gcc the file /usr/include/machine/md_var.h is included. This header defines a function "void cpu_setup(u_int)" which clashes with the "static short cpu_setup" variable in src/freebsd.cc. (#686) 2018-12-02 11:29:56 -05: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 travisCI for macOS (#524) 2018-06-19 08:07:44 -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 Fix problems found when fixing docker (#575) 2018-08-07 09:38:36 -04: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 logo upload & readme update (#630) 2018-08-20 07:40:21 -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

README.md

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).
  • Built-in Imlib2 and Cairo bindings for arbitrary drawing with Lua (more).
  • Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku OS, and macOS!

... 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 below for more screenshots and associated config files.

Documentation

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

License

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

Contributing

To report bugs or issues, open new issues. To submit code changes, open new pull requests.

Patches submitted in issues, email, or elsewhere will likely be ignored. When submitting PRs, 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