Skip to content

Commit

Permalink
style(readme): properly format paragraphs
Browse files Browse the repository at this point in the history
  • Loading branch information
trueNAHO committed Jul 4, 2023
1 parent 6cdf7cc commit 11d8431
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ 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
Expand All @@ -42,8 +41,6 @@ manipulations.
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
Expand Down Expand Up @@ -84,14 +81,15 @@ With Command Buttons you can trigger shell commands with a tap of any button.
There are many more exciting features of KMonad that you can find in the
[configuration tutorial](keymap/tutorial.kbd).


## Installation
For more information on how to install KMonad, please refer to:

- [installation](doc/installation.md)

## Configuration

For information on how to configure KMonad, please refer you to:

- [the configuration tutorial](keymap/tutorial.kbd)
- [user configurations](https://github.com/kmonad/kmonad-contrib)

Expand All @@ -102,24 +100,28 @@ username and submit a pull request!
[kmonad-contrib]: https://github.com/kmonad/kmonad-contrib

### Editor Support for the Configuration Language

- [Emacs](https://github.com/kmonad/kbd-mode)
- [Vim](https://github.com/kmonad/kmonad-vim)
- [VSCode](https://github.com/canadaduane/vscode-kmonad)

### Startup

There are startup scripts available for different init systems in
[startup](startup/).

## Troubleshooting

For several commonly asked questions regarding various configuration issues,
please see:

- [the FAQ](doc/faq.md)

## Disclaimer

The core maintainer is currently chronically ill with debilitating autoimmune
symptoms. They come and go, but when they are there they very much get in the
way of concentrated work. It is very much his intent to keep working on KMonad
until it is very, very good. But please be aware that he might be gone for weeks
on end, not out of a lack of interest, but out of a lack of capacity. You are
always free to reach out to him by email.

0 comments on commit 11d8431

Please sign in to comment.