-
-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
243dbda
commit f180cdc
Showing
11 changed files
with
126 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de> | ||
SPDX-License-Identifier: CC-BY-4.0 | ||
--> | ||
|
||
<img src="img/banner08.png"></img> | ||
|
||
# Getting Started with Kando! | ||
|
||
Kando comes with a small example menu which you can use to get started. | ||
However, you should soon [configure your own menu](configuring.md) to make the most out of Kando. | ||
|
||
|
||
## 🚀 Starting Kando for the First Time | ||
|
||
When you launch Kando, nothing will happen at first. | ||
You will only see a small icon in the system tray. | ||
However, on most platforms, you can open an example menu by pressing <kbd>Ctrl</kbd> + <kbd>Space</kbd>. | ||
|
||
There are some exceptions where this will not work. | ||
See the [platform-specific installation notes](installing.md#platform-specific-notes) for details. | ||
It can also happen that the shortcut is already used by another application. | ||
In this case, you can use the tray icon to open the settings and change the shortcut of the example menu. | ||
|
||
## 💡 The Idea of Kando | ||
|
||
<a href="https://www.youtube.com/watch?v=elHUCarOiXQ"> | ||
<img align="right" width="500px" src="img/player12.jpg"></img> | ||
</a> | ||
|
||
Kando uses [Fitts's Law](https://en.wikipedia.org/wiki/Fitts%27s_law) to make menu navigation as fast as possible. | ||
You do not have to aim at the items you want to select, but you can click anywhere in the wedge of an item. | ||
|
||
In additions, Kando is a _marking menu_ (which were [described first about 30 years ago by Gordon Kurtenbach](https://www.research.autodesk.com/app/uploads/2023/03/the-design-and-evaluation.pdf_recHpUp1v9dc1n2CJ.pdf)). | ||
As such it allows you to select items by drawing zig-zag lines. This is extremely powerful! | ||
**You can select things in subsubsubmenus in well below a second without looking at your screen!** | ||
|
||
You can watch the video on the right to get an idea of how fast you can navigate through a menu with Kando. | ||
|
||
### 🎯 The Default Navigation Modes | ||
|
||
At first, you will probably use the point-and-click method. | ||
Once you get more comfortable with Kando, you can try the marking mode, and even the turbo mode. | ||
|
||
| Navigation Method | Example | | ||
| --- | --- | | ||
| **Point and Click:** The most basic approach for selecting items is by clicking at them. Although you do not have to click directly at the item, anywhere in the item's wedge will do! <br><br> This can make selections very fast as you **do not have to aim carefully**. | <video src="https://github.com/kando-menu/kando/assets/829942/ccb9f5df-cc9e-4dd4-ac07-e37ebf797699"> | | ||
| **Marking Mode:** With Kando, you can select items by drawing gestures! To do so, simply press your left mouse button, and drag over an item. You will move the item around, until you stop the movement or make a sharp turn. Try to remember the path to an item and draw it without looking much at the menu! You will be surprised how quickly you can select items which are deeply nested in the menu. <br><br> **For successful selections, it is better to draw expressive zig-zag lines instead of shy and curvy lines :smiley:** | <video src="https://github.com/kando-menu/kando/assets/829942/bb0e0041-b599-4493-a7b1-7c39103d19cb"> | | ||
| **Turbo Mode:** If you opened the menu using a key combination, you can keep a key pressed. If you do so, the menu will behave as if the left mouse button is pressed, and you can easily browse through the menu without having to click anywhere. Once you release the key, the currently dragged item will be selected. **This allows you to make even faster selections!** <br><br> Turbo-Mode works best with <kbd>Ctrl</kbd>, <kbd>Shift</kbd>, <kbd>Alt</kbd>, or <kbd>Meta</kbd>. For all other keys there will be a short delay until Turbo-Mode kicks in. If this delay is too long for your liking, you can hit the key quickly twice - this way Kando will get the key-down event faster and Turbo-Mode will work right out of the box! | <video src="https://github.com/kando-menu/kando/assets/829942/8f56791e-f9ae-4af1-85a4-cf33da15af65"> | | ||
|
||
#### Alternative Navigation Modes | ||
|
||
People are different and so are their preferences. | ||
Therefore, Kando comes with options like the **"Centered Mode"** or the **"Anchored Mode"** which change this default behavior. | ||
Especially on smaller touch screens or with gamepad input, these options may be beneficial. | ||
|
||
You can watch the video linked above to get an idea of how these modes work. | ||
|
||
> [!TIP] | ||
> We recommend to learn the default behavior first and only change it if you are really sure that it is not working for you. It may take some time to get used to it, but it is worth it! You will be surprised how fast you _can do_ something after you mastered it! 🍰🚀 | ||
## 🛠️ Next up: Configuring Kando! | ||
|
||
Once you are comfortable with the default menu, you should [configure your own menus](configuring.md). | ||
|
||
<p align="center"><img src ="img/hr.svg" /></p> | ||
|
||
<p align="center"> | ||
<img src="img/nav-space.svg"/> | ||
<a href="installing.md"><img src ="img/left-arrow.png"/> Installing Kando</a> | ||
<img src="img/nav-space.svg"/> | ||
<a href="README.md"><img src ="img/home.png"/> Index</a> | ||
<img src="img/nav-space.svg"/> | ||
<a href="configuring.md">Configuring Kando <img src ="img/right-arrow.png"/></a> | ||
<img src="img/nav-space.svg"/> | ||
</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.