-
Notifications
You must be signed in to change notification settings - Fork 313
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "docs(readme): wrap text at 80 characters"
This reverts commit 7ef5d12.
- Loading branch information
Showing
1 changed file
with
10 additions
and
43 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,72 +14,40 @@ | |
|
|
||
| ## Introduction | ||
|
|
||
| KMonad is an advanced tool that lets you infinitely customize and extend the | ||
| functionalities of almost any keyboard. For a detailed list of features, see | ||
| [here](#features). | ||
| KMonad is an advanced tool that lets you infinitely customize and extend the functionalities of almost any keyboard. For a detailed list of features, see [here](#features). | ||
|
|
||
| If you want to get started with the latest, stable binary release, please check | ||
| out the master branch, if you are interested in the latest additions and tweaks, | ||
| switch on over to develop and compile your own binary. | ||
| If you want to get started with the latest, stable binary release, please check out the master branch, if you are interested in the latest additions and tweaks, switch on over to develop and compile your own binary. | ||
|
|
||
| Additionally, if you need any help or just want to say hi, you can join our | ||
| [Discord server](https://discord.gg/3tFfWmnahN) or jump into our [IRC | ||
| channel](https://web.libera.chat/#kmonad) (`#[email protected]`), which is | ||
| also bridged with matrix (`#kmonad:libera.chat`). | ||
| Additionally, if you need any help or just want to say hi, you can join our [Discord server](https://discord.gg/3tFfWmnahN) or jump into our [IRC channel](https://web.libera.chat/#kmonad) (`#[email protected]`), which is also bridged with matrix (`#kmonad:libera.chat`). | ||
|
|
||
| ## Features | ||
|
|
||
|
|
||
| KMonad offers advanced customization features such as **layers**, **multi-tap**, | ||
| **tap-hold**, and much more. These features are usually available at the | ||
| hardware level on the QMK-firmware enabled keyboards. However, KMonad allows you | ||
| to enjoy such features in virtually any keyboard by low-level system | ||
| manipulations. | ||
| KMonad offers advanced customization features such as **layers**, **multi-tap**, **tap-hold**, and much more. These features are usually available at the hardware level on the QMK-firmware enabled keyboards. However, KMonad allows you to enjoy such features in virtually any keyboard by low-level system manipulations. | ||
|
|
||
| For a good introduction to KMonad, have a look at [this Youtube | ||
| video](https://www.youtube.com/watch?v=Dhj1eauljwU). | ||
| For a good introduction to KMonad, have a look at [this Youtube video](https://www.youtube.com/watch?v=Dhj1eauljwU). | ||
|
|
||
|
|
||
|
|
||
| #### Key Customizations | ||
|
|
||
| KMonad lets you map any keyboard button to any keymap. Want to swap the useless | ||
| **Caps Lock** key with the **Escape** key? Want to have your modifiers such as | ||
| **Shift** and **Control** on your home row, without breaking your normal typing | ||
| flow? Want a modifier that is combination of **Alt + Ctrl + Super + Shift**? You | ||
| can do all of those and much more! | ||
| KMonad lets you map any keyboard button to any keymap. Want to swap the useless **Caps Lock** key with the **Escape** key? Want to have your modifiers such as **Shift** and **Control** on your home row, without breaking your normal typing flow? Want a modifier that is combination of **Alt + Ctrl + Super + Shift**? You can do all of those and much more! | ||
|
|
||
| #### Layers | ||
|
|
||
| A layer is a set of keymaps assigned to your keyboard's buttons. You can have as | ||
| many layers on top of your base layer as you want. For instance, you can have | ||
| your regular QWERTY layout, a Colemak/Dvorak layout, a numbers and symbols | ||
| layer, a function keys layer, a layer for mouse navigation and system controls | ||
| --- all in a 60% keyboard. When a particular layer is active, any keypress is | ||
| interpreted according to the layout defined in that layer. With proper | ||
| configurations, you can jump to a specific layer or switch to one for the next | ||
| keypress, or do various other complex manipulations. | ||
| A layer is a set of keymaps assigned to your keyboard's buttons. You can have as many layers on top of your base layer as you want. For instance, you can have your regular QWERTY layout, a Colemak/Dvorak layout, a numbers and symbols layer, a function keys layer, a layer for mouse navigation and system controls --- all in a 60% keyboard. When a particular layer is active, any keypress is interpreted according to the layout defined in that layer. With proper configurations, you can jump to a specific layer or switch to one for the next keypress, or do various other complex manipulations. | ||
|
|
||
| #### Multi-Use and Multi-Tap Buttons | ||
|
|
||
| One of the distinguishing features of KMonad are the vast capabilities with | ||
| Multi-Use Buttons. You can have a single button do different things based on | ||
| whether it is pressed quickly in succession, or pressed once, or held. For | ||
| example, you can configure the **Caps Lock** key to act as an **Escape** button | ||
| when pressed once and released, a **Ctrl** modifier when held-down, and a button | ||
| to jump to a layer when pressed twice quickly in succession. You can make the | ||
| left and right **Shift** keys to act like left and right parentheses (like the | ||
| Space Cadet Shift keys) when tapped once, and regular **Shift** keys when held | ||
| down. The possibilities are infinite! | ||
| One of the distinguishing features of KMonad are the vast capabilities with Multi-Use Buttons. You can have a single button do different things based on whether it is pressed quickly in succession, or pressed once, or held. For example, you can configure the **Caps Lock** key to act as an **Escape** button when pressed once and released, a **Ctrl** modifier when held-down, and a button to jump to a layer when pressed twice quickly in succession. You can make the left and right **Shift** keys to act like left and right parentheses (like the Space Cadet Shift keys) when tapped once, and regular **Shift** keys when held down. The possibilities are infinite! | ||
|
|
||
| #### Command Buttons | ||
|
|
||
| With Command Buttons you can trigger shell commands with a tap of any button. | ||
|
|
||
| #### And More! | ||
|
|
||
| There are many more exciting features of KMonad that you can find in the | ||
| [configuration tutorial](keymap/tutorial.kbd). | ||
| There are many more exciting features of KMonad that you can find in the [configuration tutorial](keymap/tutorial.kbd). | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
@@ -108,8 +76,7 @@ There are startup scripts available for different init systems in | |
| [startup](startup/). | ||
|
|
||
| ## Troubleshooting | ||
| For several commonly asked questions regarding various configuration issues, | ||
| please see: | ||
| For several commonly asked questions regarding various configuration issues, please see: | ||
| - [the FAQ](doc/faq.md) | ||
|
|
||
| ## Disclaimer | ||
|
|
||