Skip to content

Commit 4173223

Browse files
committed
docs(readme): fix typose and improve formatting
1 parent 45424c8 commit 4173223

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A [Rust](https://www.rust-lang.org) crate to create a pure Rust keyboard
44
firmware.
55

66
It is exposed as a library giving you the different building blocks to create a
7-
featureful keyboard firmware. As the different functionality are interconected
7+
featureful keyboard firmware. As the different functionality are interconnected
88
by the user of the crate, you can use only the parts you are interested in or
99
easily insert your own code in between.
1010

@@ -31,7 +31,7 @@ based).
3131

3232
![Ortho60](https://cdn.shopify.com/s/files/1/0238/7342/1376/products/Ortho60_1024x1024@2x.jpg)
3333

34-
Another handwired project using keyberon is
34+
Another handwired project using Keyberon is
3535
[keyberon-f4](https://github.com/TeXitoi/keyberon-f4), a unsplitted ergo
3636
keyboard. It runs on a [WeAct
3737
MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) based on a STM32F401 MCU.
@@ -66,16 +66,16 @@ handwired](https://camo.githubusercontent.com/4fca994ac2b7c1b1874d4331c2428cac21
6666

6767
The supported features are:
6868

69-
- Layers when holding a key (aka the fn key). When holding multiple layer keys,
70-
the last pressed layer action sets the layer.
69+
- Layers when holding a key (aka the `fn` key). When holding multiple layer
70+
keys, the last pressed layer action sets the layer.
7171
- Transparent key, i.e. when on an alternative layer, the key will inherit the
7272
behavior of the default layer.
7373
- Change default layer dynamically.
74-
- Multiple keys sent on an single key press. It allows to have keys for complex
74+
- Multiple keys sent on a single key press. It allows having keys for complex
7575
shortcut, for example a key for copy and paste or alt tab, or for whatever you
7676
want.
77-
- Chording multiple keys together to act as a single key
78-
- hold tap: different action depending if the key is held or tapped. For
77+
- Chording multiple keys together to act as a single key.
78+
- hold tap: different action depending on if the key is held or tapped. For
7979
example, you can have a key acting as layer change when held, and space when
8080
tapped.
8181

@@ -85,12 +85,12 @@ The supported features are:
8585

8686
To find new, findable and memorable project names, some persons in the Rust
8787
community try to mix the name of a city with some keyword related to the
88-
project. For example, you have the [Tokio project](https://tokio.rs/) that
88+
project. For example, you have the [Tokio](https://tokio.rs/) project that
8989
derive its name from the Japanese capital Tokyo and IO for Input Output, the
9090
main subject of this project.
9191

9292
So, I have to find such a name. In the mechanical keyboard community, "keeb" is
93-
slang for keyboard. Thus, I searched for a city with the sound [kib], preferably
94-
in France as it is the country of origin of the project. I found
93+
slang for keyboard. Thus, I searched for a city with the sound *[kib]*,
94+
preferably in France as it is the country of origin of the project. I found
9595
[Quiberon](https://en.wikipedia.org/wiki/Quiberon), and thus I named the project
96-
Keyberon.
96+
`Keyberon`.

0 commit comments

Comments
 (0)