## 1. Project Overview & Quickstart (kando-menu/kando) ## File: README.md [](https://github.com/kando-menu/kando/actions) [](https://github.com/kando-menu/kando/actions) [](https://api.reuse.software/info/github.com/kando-menu/kando) [](https://hosted.weblate.org/engage/kando/) [](https://github.com/kando-menu/kando/releases) [](https://schneegans.github.io/sponsors/) [](https://discord.gg/hZwbVSDkhy) [](https://kando.menu) [](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! 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 Ctrl+Space 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! Graphic made with [contrib.rocks](https://contrib.rocks). **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**. [](https://ko-fi.com/schneegans) [](https://github.com/sponsors/Schneegans) [](https://www.paypal.com/donate/?hosted_button_id=3F7UFL8KLVPXE) [](https://schneegans.cb.id) **These awesome people have already donated to the development of my open-source projects:** --- ## File: assets/icons/README.md # 🌸 Icons for Kando This directory contains various icons used in Kando. You should not edit these files directly as they are automatically generated. The sources for these icons and the script to generate them can be found in Kando's [🎨 Design Repository](https://github.com/kando-menu/design). --- ## File: docs/code-of-conduct.md # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement the content-reporting system on GitHub, via a private Discord message, or via an @-mention on GitHub. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. --- ## File: docs/README.md # :cherry_blossom: Visit Kando's Homepage! A lot of information is located at https://kando.menu. If you have more questions, feel free to join the [Kando Discord server](https://discord.gg/hZwbVSDkhy). Here are some quick links to get you started: - [Installation on Windows](https://kando.menu/installation-on-windows/) - [Installation on Linux](https://kando.menu/installation-on-linux/) - [Installation on macOS](https://kando.menu/installation-on-macos/) - [Compiling Kando from Source](https://kando.menu/compile-from-source/) - [Config-file Reference](https://kando.menu/config-files/) ## 2. Official Technical Reference & Guides (kando-menu/kando-menu.github.io) # The Homepage of [Kando](https://github.com/kando-menu/kando) [](https://api.reuse.software/info/github.com/kando-menu/kando-menu.github.io) Welcome to the Kando documentation site! This site is available online at https://kando.menu. Feel free to improve the documentation by submitting a pull request to this repository. If you want to preview your changes locally, you only need to clone your fork and run the following commands: ```bash npm install npm run dev ``` This will start a local development server at http://localhost:4321. This page uses the [Starlight](https://starlight.astro.build/getting-started/) theme for the [Astro](https://docs.astro.build/en/getting-started/) framework to generate static HTML files. You can find some documentation about the frameworks by using these links.