1[![Linux build](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-linux.yaml/badge.svg)](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-linux.yaml) [![macOS build](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-macos.yaml/badge.svg)](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-macos.yaml) [![Docker build](https://github.com/brndnmtthws/conky/actions/workflows/docker.yaml/badge.svg)](https://github.com/brndnmtthws/conky/actions/workflows/docker.yaml) [![AppImage build](https://github.com/brndnmtthws/conky/actions/workflows/publish-appimage.yml/badge.svg)](https://github.com/brndnmtthws/conky/actions/workflows/publish-appimage.yml)
2
3[![pipeline status](https://gitlab.com/brndnmtthws-oss/conky/badges/main/pipeline.svg)](https://gitlab.com/brndnmtthws-oss/conky/commits/main) [![coverage report](https://gitlab.com/brndnmtthws-oss/conky/badges/main/coverage.svg)](https://gitlab.com/brndnmtthws-oss/conky/commits/main)
4
5[�� Join the Matrix chat](https://matrix.to/#/#conky:frens.io)
6
7<p align="center"><img width="300" src="logo/conky-logotype-horizontal-violet.png"></p>
8
9**Conky** is a free, light-weight system monitor for X, that displays
10any kind of information on your desktop.
11
12�� Grab the [latest release from GitHub](https://github.com/brndnmtthws/conky/releases/latest).
13
14[�� An introduction to Conky (YouTube)](https://www.youtube.com/watch?v=bHtpLEoRKmg&t=19s).
15
16## Features
17
18Conky can display more than 300 built-in objects, including support for:
19
20- A plethora of OS stats (uname, uptime, **CPU usage**, **mem
21  usage**, disk usage, **"top"** like process stats, and **network
22  monitoring**, just to name a few).
23- Built-in **IMAP** and **POP3** support.
24- Built-in support for many popular music players ([MPD][],
25  [XMMS2][], [Audacious][]).
26- Can be extended using built-in [**Lua**](lua) support, or any of your
27  own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
28- Built-in [**Imlib2**][imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
29  with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua)).
30- Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku, and macOS!
31- [Docker image](https://hub.docker.com/r/brndnmtthws/conky/) available for amd64, armv7, and aarch64 (aka armv8)
32
33... and much much more.
34
35Conky can display information either as text, or using simple progress
36bars and graph widgets, with different fonts and colours.
37
38## Screenshots
39
40[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/brenden/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
41[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/ke49/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
42[![screenshot](https://github.com/brndnmtthws/conky/wiki/configs/jc/screenshot-thumb.png)](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
43
44See the User Configs below for more screenshots and associated config files.
45
46## Quickstart
47
48Conky 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:
49
50```ShellSession
51$ curl -sL -o conky-x86_64.AppImage \
52    $(curl -sL https://api.github.com/repos/brndnmtthws/conky/releases/latest | \
53    jq --raw-output '.assets[0] | .browser_download_url')
54$ ls
55conky-x86_64.AppImage
56```
57
58If you don't have `jq` and `curl` installed, go to
59https://github.com/brndnmtthws/conky/releases/latest and fetch the latest
60AppImage. Then:
61
62```ShellSession
63$ chmod +x ./conky-x86_64.AppImage
64$ ./conky-x86_64.AppImage -C > ~/.conkyrc
65$ ./conky-x86_64.AppImage
66```
67
68And that's it! [Check out the Wiki](https://github.com/brndnmtthws/conky/wiki) for more details on configuring Conky.
69
70_Note_: To use the AppImage, you may need to install additional runtime libraries.
71
72## Documentation
73
74The [GitHub Wiki](https://github.com/brndnmtthws/conky/wiki) serves as a central hub for all of
75Conky's documentation.
76
77- [Installation](https://github.com/brndnmtthws/conky/wiki/Installation)
78- [Configuration Settings](https://github.com/brndnmtthws/conky/wiki/Configurations)
79- [User Configs](https://github.com/brndnmtthws/conky/wiki/Configs)
80- [Frequently Asked Questions](https://github.com/brndnmtthws/conky/wiki/FAQ)
81
82## License
83
84Conky is licensed under the terms of the [GPLv3](LICENSE) license.
85
86## Contributing
87
88Contributions are welcome from anyone.
89
90Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to Conky.
91
92[mpd]: https://musicpd.org/
93[xmms2]: https://github.com/xmms2/wiki/wiki
94[audacious]: https://audacious-media-player.org/
95[luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
96[imlib2]: https://docs.enlightenment.org/api/imlib2/html/
97[cairo]: https://www.cairographics.org/
98
99## Supporting this project
100
101Conky exists only through the hard work of a collection of volunteers. Please
102consider sponsoring the project's developers if you get value out of Conky.
103
104## Stargazers over time
105
106[![Stargazers over time](https://starchart.cc/brndnmtthws/conky.svg)](https://starchart.cc/brndnmtthws/conky)
107