1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-15 17:47:09 +00:00
Go to file
Brenden Matthews 47ad3f9982 Refactor docs, make a new website.
* Docs have been migrated from docbook to yaml + jinja2 + pandoc
* Created a new (basic) website for docs based on React + Tailwinds
2022-09-30 18:21:24 -04:00
.github Switch release discussion category. 2022-09-19 10:16:35 -05:00
3rdparty/toluapp Drop luajit support (Lua 5.1 API). 2018-12-24 10:07:20 -05:00
appimage Add sha256sum for appimage artifact. 2022-09-12 13:15:12 -05:00
bin Fix python command for clang checks (2 -> 3). 2020-01-08 13:20:17 -05:00
cmake Refactor docs, make a new website. 2022-09-30 18:21:24 -04:00
data Correct dependencies on generated header files 2022-09-10 13:14:13 -04:00
doc Refactor docs, make a new website. 2022-09-30 18:21:24 -04:00
extras Linux: show the scaling governor with $cpugovernor. 2022-09-24 12:05:09 -04:00
logo Add AppImage integration. 2019-01-08 19:44:24 -05:00
lua Require librsvg >=2.52. 2022-09-10 11:58:27 -05:00
src Replace atoi and atol with strtol (most files). 2022-09-25 18:24:03 -04:00
tests Comment out rsvg_handle_get_intrinsic_size_in_pixels for now. 2022-09-10 11:57:16 -05:00
web Refactor docs, make a new website. 2022-09-30 18:21:24 -04: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 Update dockerignore. 2021-03-02 08:02:53 -06:00
.editorconfig Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.gitignore added intellij to .gitignore 2021-01-23 18:00:53 -06:00
AUTHORS Reverted the AUTHORS file and added my name. 2021-04-22 10:06:36 -05:00
CMakeLists.txt Refactor docs, make a new website. 2022-09-30 18:21:24 -04:00
conky.desktop Add AppImage integration. 2019-01-08 19:44:24 -05:00
CONTRIBUTING.md Reorganize, adjust wording. 2019-03-04 11:14:07 -05:00
COPYING Update copyright, authors. 2021-02-27 09:14:19 -06:00
Dockerfile Add missing docker build deps. 2022-09-10 13:05:39 -05:00
LICENSE GPLv3 is the default license. 2018-01-25 09:26:33 -05:00
LICENSE.BSD Update copyright, authors. 2021-02-27 09:14:19 -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 Update README.md 2022-09-19 12:14:41 -04:00
sonar-project.properties Add some basic unit tests. 2018-12-24 02:02:01 -05:00
TODO.md Add TODO for the gui-backends branch 2022-09-10 20:39:11 +02:00

Linux build macOS build Docker build AppImage build

💬 Join the Matrix chat

Conky is a free, light-weight system monitor for X, that displays any kind of information on your desktop. It can also run on macOS, output to your console, a file, or even HTTP (oh my!).

👉 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, and macOS!
  • Docker image available for amd64, armv7, and aarch64 (aka armv8)

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

Supporting this project

Conky exists only through the hard work of a collection of volunteers. Please consider sponsoring the project's developers if you get value out of Conky.

Stargazers over time

Stargazers over time