Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-27 04:32:55 +00:00
Code Issues Releases Activity
f7c15b027a
conky/README.md
Brenden Matthews 26d23cb707
Update README.md
2019-11-01 17:41:54 -04:00

4.2 KiB
Raw Blame History

Build Status pipeline status coverage report

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.

Quickstart

Conky comes bundled with many package managers. However, if you'd like to try the latest release of Conky, you can try the AppImage build. If you have jq and curl installed, run the following command to fetch the latest AppImage:

$ curl -sL -o conky-x86_64.AppImage \
    $(curl -sL https://api.github.com/repos/brndnmtthws/conky/releases/latest | \
    jq --raw-output '.assets[0] | .browser_download_url')
$ ls
conky-x86_64.AppImage

If you don't have jq and curl installed, go to https://github.com/brndnmtthws/conky/releases/latest and fetch the latest AppImage. Then:

$ chmod +x ./conky-x86_64.AppImage
$ ./conky-x86_64.AppImage -C > ~/.conkyrc
$ ./conky-x86_64.AppImage

And that's it! Check out the Wiki for more details on configuring Conky.

Note: To use the AppImage, you may need to install additional runtime libraries.

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

Contributing

Contributions are welcome from anyone.

Please read CONTRIBUTING.md for guidelines on contributing to Conky.