@@ -4,7 +4,7 @@ A [Rust](https://www.rust-lang.org) crate to create a pure Rust keyboard
44firmware.
55
66It 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
88by the user of the crate, you can use only the parts you are interested in or
99easily insert your own code in between.
1010
@@ -20,21 +20,21 @@ crate](https://crates.io/crates/embedded-hal) to read the key states, and the
2020The first project using this firmware is [ Keyberon
2121grid] ( https://github.com/TeXitoi/keyberon-grid ) , a handwired keyboard with a
2222grid of keys. It is based on the blue pill, a cheap development board based on a
23- STM32F103 MCU.
23+ STM32F103 MCU:
2424
2525![ keyberon-grid] ( https://raw.githubusercontent.com/TeXitoi/keyberon-grid/master/images/keyberon.jpg )
2626
2727There is a [ port] ( https://github.com/TeXitoi/ortho60-keyberon ) to [ Cannon
2828Keys] ( https://cannonkeys.com/ ) 's [ Ortho60 keyboard
2929kit] ( https://cannonkeys.com/collections/frontpage/products/ortho60 ) (blue pill
30- based).
30+ 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
3636keyboard. It runs on a [ WeAct
37- MiniF4] ( https://github.com/WeActTC/MiniF4-STM32F4x1 ) based on a STM32F401 MCU.
37+ MiniF4] ( https://github.com/WeActTC/MiniF4-STM32F4x1 ) based on a STM32F401 MCU:
3838
3939![ keyberon-f4] ( https://raw.githubusercontent.com/TeXitoi/keyberon-f4/master/images/keyberon-44.jpg )
4040
@@ -53,11 +53,11 @@ MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) based):
5353![ covah901] ( https://i.redd.it/gnkfymu0gwo41.jpg )
5454
5555[ KeySeeBee] ( https://github.com/TeXitoi/keyseebee ) , a split ergo keyboard
56- (STM32F072 based).
56+ (STM32F072 based):
5757
5858![ KeySeeBee] ( https://raw.githubusercontent.com/TeXitoi/keyseebee/master/images/keyseebee.jpg )
5959
60- [ Arisu handwired] ( https://github.com/help-14/arisu-handwired ) using STM32F401.
60+ [ Arisu handwired] ( https://github.com/help-14/arisu-handwired ) using STM32F401:
6161
6262![ Arisu
6363handwired] ( https://camo.githubusercontent.com/4fca994ac2b7c1b1874d4331c2428cac211ff80c2891c75c971d15630ef0a948/68747470733a2f2f692e696d6775722e636f6d2f30334c356f63702e6a7067 )
@@ -66,16 +66,16 @@ handwired](https://camo.githubusercontent.com/4fca994ac2b7c1b1874d4331c2428cac21
6666
6767The 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
8686To find new, findable and memorable project names, some persons in the Rust
8787community 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
8989derive its name from the Japanese capital Tokyo and IO for Input Output, the
9090main subject of this project.
9191
9292So, 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