Go to file
Brenden Matthews 90673cf161 Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.github github: add issues+pull requests templates 2019-01-04 15:23:47 -06:00
3rdparty/toluapp Drop luajit support (Lua 5.1 API). 2018-12-24 10:07:20 -05:00
appimage Use appimagetool to generate final appimage. 2019-02-22 21:12:15 -05:00
bin Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
cmake Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
data update copyright year to 2019 2019-01-05 11:15:36 -06:00
doc conky: Allow hwmon command to accept hwmon device name 2019-02-17 09:24:15 -05:00
extras remove deprecated BMPx support 2019-01-04 19:58:52 -06:00
logo Add AppImage integration. 2019-01-08 19:44:24 -05:00
lua Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
src Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
tests Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.clang-format Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.clang-tidy Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.dockerignore Refactor Dockerfile. 2019-02-21 09:21:22 -05:00
.editorconfig Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.gitignore Add AppImage integration. 2019-01-08 19:44:24 -05:00
.gitlab-ci.yml Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.travis.yml Fix key import command. 2019-02-22 20:55:45 -05:00
AUTHORS Basic macOS support (#480) 2018-05-07 07:27:32 -04:00
CMakeLists.txt Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
COPYING update copyright year to 2019 2019-01-05 11:15:36 -06:00
Dockerfile Refactor Dockerfile. 2019-02-21 09:21:22 -05:00
Dockerfile.builder Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
LICENSE GPLv3 is the default license. 2018-01-25 09:26:33 -05:00
LICENSE.BSD update copyright year to 2019 2019-01-05 11:15:36 -06: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 Fix logo path in readme. 2019-01-09 11:14:26 -05:00
conky.desktop Add AppImage integration. 2019-01-08 19:44:24 -05:00
sonar-project.properties Add some basic unit tests. 2018-12-24 02:02:01 -05:00

README.md

Build Status Quality Gate Maintainability Code Coverage Sonarcloud Bugs

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.

📹 An introduction to Conky (YouTube).

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, 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