<!--
SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
SPDX-License-Identifier: CC-BY-4.0
-->

<p align="center">
  <a href="https://www.youtube.com/watch?v=I5SCWVLgv3E"><img src="docs/img/video.jpg" /></a>
</p>

[![checks](https://img.shields.io/github/actions/workflow/status/kando-menu/kando/checks.yml?branch=main&logo=github&label=Checks)](https://github.com/kando-menu/kando/actions)
[![codeql](https://img.shields.io/github/actions/workflow/status/kando-menu/kando/github-code-scanning/codeql?branch=main&logo=github&label=CodeQL)](https://github.com/kando-menu/kando/actions)
[![reuse](https://api.reuse.software/badge/github.com/kando-menu/kando)](https://api.reuse.software/info/github.com/kando-menu/kando)
[![translate](https://hosted.weblate.org/widget/kando/svg-badge.svg)](https://hosted.weblate.org/engage/kando/)
[![downloads](https://img.shields.io/github/downloads/kando-menu/kando/total?label=Downloads)](https://github.com/kando-menu/kando/releases)
[![sponsors](https://gist.githubusercontent.com/Schneegans/2d06edf0937c480951feb86b9e719304/raw/weekly.svg)](https://schneegans.github.io/sponsors/)
[![Discord](https://img.shields.io/discord/1124300911574003732?logo=discord&label=Discord&color=%235865f2&logoColor=fff)](https://discord.gg/hZwbVSDkhy)
[![docs](https://img.shields.io/badge/Docs_at-kando.menu-9f3b67.svg?logo=kando&labelColor=303030)](https://kando.menu)
[![contributions](https://img.shields.io/badge/🎉_Contributions-welcome-green.svg?labelColor=303030)](https://github.com/kando-menu/kando/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22)


# What is Kando?

**🌸 Kando is a cross-platform pie menu for your desktop.**
It offers an unconventional, fast, highly efficient, and fun way of interacting with your computer!
You can use Kando to launch applications, simulate keyboard shortcuts, open files, and much more.

Kando is designed to be used with 🖱️ mouse, 🖊️ stylus, 👆 touch, or 🎮 controller input.
However, Kando can also be efficiently controlled with a keyboard.

You are welcome to join the 💬 [Discord server](https://discord.gg/hZwbVSDkhy) to discuss the project, ask questions, or just to hang out with other Kando enthusiasts!

<p align="center">
  <img src="docs/img/kando.gif"/>
</p>


Kando runs on Windows, macOS, and Linux.
On Linux, most desktop environments are supported, however some require additional configuration.
Have a look at the [installation guide](https://kando.menu/installation-on-linux/) for more information.

# :package: Where do I get Kando?

There are several ways to install Kando, depending on your operating system and preferences.
If you want to install the latest release, you can read the respective instructions for [Windows](https://kando.menu/installation-on-windows/), [macOS](https://kando.menu/installation-on-macos/), or [Linux](https://kando.menu/installation-on-linux/).

You can also [build Kando from source](https://kando.menu/compile-from-source/).
This is only required if you want to contribute to the project or if you want to use the latest features that are not yet released.

# :rocket: How do I use Kando?

Kando comes with an example menu which you can open by pressing <kbd>Ctrl</kbd>+<kbd>Space</kbd> on most platforms.
This is great to get a first impression!
To learn some basics about the interaction with Kando, you can have a look at the [:memo: Usage Guide](https://kando.menu/usage/).

Once you are familiar with the basics, you can start creating your own menus.
Learn how to create your own menus in the [:memo: Configuration Guide](https://kando.menu/creating-menus/)!

# :revolving_hearts: Who creates Kando?

👋 Hi there! I am [**@Schneegans**](https://github.com/Schneegans/), a software developer from Germany who loves creating free and open-source software.
After [Gnome-Pie](https://github.com/Schneegans/Gnome-Pie) and [Fly-Pie](https://github.com/Schneegans/Fly-Pie/), Kando is my third and most ambitious attempt to create a pie menu for the desktop.

Yet the project would not have been possible without the help of the community!
A big thanks to everyone who has contributed to Kando by reporting issues, suggesting features, translating texts, or writing code!

<a href="https://github.com/kando-menu/kando/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=kando-menu/kando&columns=20" />
</a>

<small>Graphic made with [contrib.rocks](https://contrib.rocks).</small>

**Also, a huge thanks to [SignPath.io](https://signpath.io/) for providing the code signing infrastructure and to the [SignPath Foundation](https://signpath.org/) for providing a free code signing certificate for the Windows installers!**
For details, see also our [:handshake: Code-Signing Policy](https://kando.menu/code-signing/).

# :tada: I want to contribute as well!

Kando is completely free, but I would be very happy if you could support the project with creative ideas, code contributions, or by sharing it with your friends and followers! 💖

There are always some open issues labeled as [good first issue](https://github.com/kando-menu/kando/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which are a great starting point for new contributors.
Just drop a comment if you want to work on one of these issues, and we can discuss the details!

While direct contributions are the most awesome way to support the development, **donations will encourage me to invest my spare time for developing free and open-source software**.

[![kofi](https://img.shields.io/badge/Donate%20on%20Ko--fi-FF6433?logo=kofi&logoColor=fff&style=flat-square)](https://ko-fi.com/schneegans)
[![github](https://img.shields.io/badge/Donate%20on%20GitHub-EA4AAA?logo=githubsponsors&logoColor=fff&style=flat-square)](https://github.com/sponsors/Schneegans)
[![paypal](https://img.shields.io/badge/Donate%20on%20PayPal-003087?logo=paypal&logoColor=fff&style=flat-square)](https://www.paypal.com/donate/?hosted_button_id=3F7UFL8KLVPXE)
[![crypto](https://img.shields.io/badge/Donate%20some%20Crypto-F7931A?logo=bitcoin&logoColor=fff&style=flat-square)](https://schneegans.cb.id)


**These awesome people have already donated to the development of my open-source projects:**

<a href="https://schneegans.github.io/sponsors/">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://schneegans.github.io/sponsors/sponsors_dark_small.svg">
    <img alt="Sponsors List" src="https://schneegans.github.io/sponsors/sponsors_light_small.svg#gh-light-mode-only">
  </picture>
</a>

<p align="center"><img src ="docs/img/hr.svg" /></p>
