-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): fix typos and improve formatting
- Loading branch information
Showing
1 changed file
with
16 additions
and
16 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 |
---|---|---|
|
@@ -4,7 +4,7 @@ A [Rust](https://www.rust-lang.org) crate to create a pure Rust keyboard | |
firmware. | ||
|
||
It is exposed as a library giving you the different building blocks to create a | ||
featureful keyboard firmware. As the different functionality are interconected | ||
featureful keyboard firmware. As the different functionality are interconnected | ||
by the user of the crate, you can use only the parts you are interested in or | ||
easily insert your own code in between. | ||
|
||
|
@@ -20,21 +20,21 @@ crate](https://crates.io/crates/embedded-hal) to read the key states, and the | |
The first project using this firmware is [Keyberon | ||
grid](https://github.com/TeXitoi/keyberon-grid), a handwired keyboard with a | ||
grid of keys. It is based on the blue pill, a cheap development board based on a | ||
STM32F103 MCU. | ||
STM32F103 MCU: | ||
|
||
![keyberon-grid](https://raw.githubusercontent.com/TeXitoi/keyberon-grid/master/images/keyberon.jpg) | ||
|
||
There is a [port](https://github.com/TeXitoi/ortho60-keyberon) to [Cannon | ||
Keys](https://cannonkeys.com/)'s [Ortho60 keyboard | ||
kit](https://cannonkeys.com/collections/frontpage/products/ortho60) (blue pill | ||
based). | ||
based): | ||
|
||
![Ortho60](https://cdn.shopify.com/s/files/1/0238/7342/1376/products/[email protected]) | ||
|
||
Another handwired project using keyberon is | ||
Another handwired project using Keyberon is | ||
[keyberon-f4](https://github.com/TeXitoi/keyberon-f4), a unsplitted ergo | ||
keyboard. It runs on a [WeAct | ||
MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) based on a STM32F401 MCU. | ||
MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) based on a STM32F401 MCU: | ||
|
||
![keyberon-f4](https://raw.githubusercontent.com/TeXitoi/keyberon-f4/master/images/keyberon-44.jpg) | ||
|
||
|
@@ -53,11 +53,11 @@ MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) based): | |
![covah901](https://i.redd.it/gnkfymu0gwo41.jpg) | ||
|
||
[KeySeeBee](https://github.com/TeXitoi/keyseebee), a split ergo keyboard | ||
(STM32F072 based). | ||
(STM32F072 based): | ||
|
||
![KeySeeBee](https://raw.githubusercontent.com/TeXitoi/keyseebee/master/images/keyseebee.jpg) | ||
|
||
[Arisu handwired](https://github.com/help-14/arisu-handwired) using STM32F401. | ||
[Arisu handwired](https://github.com/help-14/arisu-handwired) using STM32F401: | ||
|
||
![Arisu | ||
handwired](https://camo.githubusercontent.com/4fca994ac2b7c1b1874d4331c2428cac211ff80c2891c75c971d15630ef0a948/68747470733a2f2f692e696d6775722e636f6d2f30334c356f63702e6a7067) | ||
|
@@ -66,16 +66,16 @@ handwired](https://camo.githubusercontent.com/4fca994ac2b7c1b1874d4331c2428cac21 | |
|
||
The supported features are: | ||
|
||
- Layers when holding a key (aka the fn key). When holding multiple layer keys, | ||
the last pressed layer action sets the layer. | ||
- Layers when holding a key (aka the `fn` key). When holding multiple layer | ||
keys, the last pressed layer action sets the layer. | ||
- Transparent key, i.e. when on an alternative layer, the key will inherit the | ||
behavior of the default layer. | ||
- Change default layer dynamically. | ||
- Multiple keys sent on an single key press. It allows to have keys for complex | ||
- Multiple keys sent on a single key press. It allows having keys for complex | ||
shortcut, for example a key for copy and paste or alt tab, or for whatever you | ||
want. | ||
- Chording multiple keys together to act as a single key | ||
- hold tap: different action depending if the key is held or tapped. For | ||
- Chording multiple keys together to act as a single key. | ||
- hold tap: different action depending on if the key is held or tapped. For | ||
example, you can have a key acting as layer change when held, and space when | ||
tapped. | ||
|
||
|
@@ -85,12 +85,12 @@ The supported features are: | |
|
||
To find new, findable and memorable project names, some persons in the Rust | ||
community try to mix the name of a city with some keyword related to the | ||
project. For example, you have the [Tokio project](https://tokio.rs/) that | ||
project. For example, you have the [Tokio](https://tokio.rs/) project that | ||
derive its name from the Japanese capital Tokyo and IO for Input Output, the | ||
main subject of this project. | ||
|
||
So, I have to find such a name. In the mechanical keyboard community, "keeb" is | ||
slang for keyboard. Thus, I searched for a city with the sound [kib], preferably | ||
in France as it is the country of origin of the project. I found | ||
slang for keyboard. Thus, I searched for a city with the sound *[kib]*, | ||
preferably in France as it is the country of origin of the project. I found | ||
[Quiberon](https://en.wikipedia.org/wiki/Quiberon), and thus I named the project | ||
Keyberon. | ||
`Keyberon`. |