Correct spelling of common words in .md files
This commit is contained in:
parent
c7eaeaf90c
commit
09d0287800
@ -54,7 +54,7 @@ if __name__ == '__main__':
|
||||
### You're extremely lucky and you have a fully supported keyboard
|
||||
If your keyboard and microcontroller are officially supported, simply visit the page for your files, and dropping them on the root of the "flash drive". Those pages can be found [here](https://github.com/KMKfw/kmk_firmware/tree/master/boards). You will need the `kb.py` and `main.py`. More advanced instructions can be found [here](config_and_keymap.md).
|
||||
|
||||
### You've got another, maybe DIY, board and want to customise KMK for it
|
||||
### You've got another, maybe DIY, board and want to customize KMK for it
|
||||
First, be sure to understand how your device work, and particularly its specific matrix configuration. You can have a look [here](http://pcbheaven.com/wikipages/How_Key_Matrices_Works/) or read the [guide](https://docs.qmk.fm/#/hand_wire) provided by the QMK team for handwired keyboards
|
||||
<br>Once you've got the gist of it:
|
||||
- You can have a look [here](config_and_keymap.md) and [here](keys.md) to start customizing your code.py / main.py file
|
||||
@ -64,7 +64,7 @@ First, be sure to understand how your device work, and particularly its specific
|
||||
And to go even further:
|
||||
- [Sequences](sequences.md) are used for sending multiple keystrokes in a single action
|
||||
- [Layers](layers.md) can transform the whole way your keyboard is behaving with a single touch
|
||||
- [ModTap](modtap.md) allow you to customize the way a key behaves wether it is tapped or hold, and [TapDance](tapdance.md) depending on the number of times it is pressed
|
||||
- [ModTap](modtap.md) allow you to customize the way a key behaves whether it is tapped or hold, and [TapDance](tapdance.md) depending on the number of times it is pressed
|
||||
|
||||
Want to have fun features such as RGB, split keyboards and more? Check out what builtin [modules](modules.md) and [extensions](extensions.md) can do!
|
||||
You can also get ideas from the various [user examples](https://github.com/KMKfw/kmk_firmware/tree/master/user_keymaps) that we provide and dig into our [documentation](README.md).
|
||||
|
@ -1,6 +1,6 @@
|
||||
# CapsWord
|
||||
The capsword module functions similar to caps lock but will deactive automatically when its encounters a key that breaks the word or after inactivity timeout.
|
||||
By default it will not deactive capsword on numbers, alphabets, underscore, modifiers, minus, backspace and other keys like modtap, layers, etc.
|
||||
The capsword module functions similar to caps lock but will deactivate automatically when its encounters a key that breaks the word or after inactivity timeout.
|
||||
By default it will not deactivate capsword on numbers, alphabets, underscore, modifiers, minus, backspace and other keys like modtap, layers, etc.
|
||||
Add it to your keyboard's modules list with:
|
||||
|
||||
```python
|
||||
|
@ -15,7 +15,7 @@ corresponding handlers.
|
||||
Combos may overlap, i.e. share match keys amongst each other.
|
||||
|
||||
The optional arguments `timeout` and `per_key_timeout` define the time window
|
||||
within which the match has to happen and wether the timeout is renewed after
|
||||
within which the match has to happen and whether the timeout is renewed after
|
||||
each key press, respectively. These can be customized for every combo
|
||||
individually.
|
||||
|
||||
|
@ -30,7 +30,7 @@ them to be executed in a desktop development environment.
|
||||
|
||||
Execute tests using the command `python -m unittest`.
|
||||
|
||||
## Contriburing Documentation
|
||||
## Contributing Documentation
|
||||
While KMK welcomes documentation from anyone with and understanding of the issues
|
||||
and a willingness to write them up, it's a good idea to familiarize yourself with
|
||||
the docs. Documentation should be informative but concise.
|
||||
@ -61,7 +61,7 @@ functions or Python keywords within the body of paragraphs or in lists.
|
||||
## License, Copyright, and Legal
|
||||
|
||||
All software in this repository is licensed under the [GNU Public License,
|
||||
verison 3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).
|
||||
version 3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).
|
||||
All documentation and hardware designs are licensed under the [Creative Commons
|
||||
Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
license. Contributions to this repository must use these licenses unless
|
||||
|
@ -6,7 +6,7 @@ I2C encoder type has been tested with the Adafruit I2C QT Rotary Encoder with Ne
|
||||
## Enabling the extension
|
||||
The constructor(`EncoderHandler` class) takes a list of encoder, each one defined as either:
|
||||
|
||||
* a list of pad_a pin, pad_b pin, button_pin and optionnally a flag set to True is you want it to be reversed
|
||||
* a list of pad_a pin, pad_b pin, button_pin and optionally a flag set to True is you want it to be reversed
|
||||
* a `busio.I2C`, address and optionally a flag set to True if you want it to be reversed
|
||||
|
||||
The encoder_map is modeled after the keymap and works the same way. It should have as many layers (key pressed on "turned left", key pressed on "turned right", key pressed on "knob pressed") as your keymap, and use KC.NO keys for layers that you don't require any action.
|
||||
|
@ -1,8 +1,8 @@
|
||||
# Status LEDs
|
||||
|
||||
Indicate which layer you are on with ah array of single leds.
|
||||
Indicate which layer you are on with an array of single leds.
|
||||
|
||||
During startup the leds light up to indicte that the bootup is finished.
|
||||
During startup the leds light up to indicate that the bootup is finished.
|
||||
|
||||
For the time being just a simple consecutive single led
|
||||
indicator. And when there are more layers than leds it
|
||||
|
@ -88,7 +88,7 @@ These same steps are run for when a key is released.
|
||||
|
||||
_So now... what's a handler, and what's a pre/post callback?!_
|
||||
|
||||
All of these serve rougly the same purpose: to _do something_ with the key's
|
||||
All of these serve roughly the same purpose: to _do something_ with the key's
|
||||
data, or to fire off side effects. Most handlers are provided by KMK internally
|
||||
and modify the `InternalState` in some way - adding the key to the HID queue,
|
||||
changing layers, etc. The pre/post handlers are designed to allow functionality
|
||||
|
@ -35,7 +35,7 @@ KC.MT(KC.TAP, KC.HOLD, prefer_hold=True, tap_interrupted=False, tap_time=None)
|
||||
```
|
||||
* `prefer_hold`: decides which keycode the ModTap key resolves to when another
|
||||
key is pressed before the timeout finishes. When `True` the hold keycode is
|
||||
choosen, the tap keycode when `False`.
|
||||
chosen, the tap keycode when `False`.
|
||||
* `tap_interrupted`: decides if the timeout will interrupt at the first other
|
||||
key press/down, or after the first other key up/release. Set to `True` for
|
||||
interrupt on release.
|
||||
|
@ -16,7 +16,7 @@ class KMKKeyboard(_KMKKeyboard):
|
||||
|
||||
## REQUIRED
|
||||
This is designed to be replaced with the defining pins of your keyboard. Rows,
|
||||
colums and the diode direction (if any), should be defined like this
|
||||
columns and the diode direction (if any), should be defined like this
|
||||
```python
|
||||
row_pins = [board.p0_31, board.p0_29, board.p0_02, board.p1_15]
|
||||
col_pins = [board.p0_22, board.p0_24, board.p1_00, board.p0_11, board.p1_04]
|
||||
@ -25,15 +25,15 @@ colums and the diode direction (if any), should be defined like this
|
||||
|
||||
## Additional pins for extensions
|
||||
KMK includes built in extensions for RGB and split keyboards, and powersave. If
|
||||
these are applicible on your keyboard/microcontroller, the pins should be added
|
||||
these are applicable on your keyboard/microcontroller, the pins should be added
|
||||
here. Refer to the instructions on the respective extensions page on how to add
|
||||
them. If not adding any extensions, leave this as an empty list as shown.
|
||||
|
||||
# Coord mapping
|
||||
If your keyboard is not built electrically as a square (though most are), you can
|
||||
provide a mapping directly. An example of this is the
|
||||
[Corne](https://github.com/foostan/crkbd). That has 12 colums for 3 rows, and 6
|
||||
colums for the bottom row. Split keyboards count as the total keyboard, not per
|
||||
[Corne](https://github.com/foostan/crkbd). That has 12 columns for 3 rows, and 6
|
||||
columns for the bottom row. Split keyboards count as the total keyboard, not per
|
||||
side, the right side being offset by the number of keys on the left side, as if
|
||||
the rows were stacked.
|
||||
That would look like this
|
||||
@ -66,7 +66,7 @@ coord_mapping = [
|
||||
## Keymaps
|
||||
Keymaps are organized as a list of lists. Keycodes are added for every key on
|
||||
each layer. See [keycodes](keycodes.md) for more details on what keycodes are
|
||||
avaliable. If using layers or other extensions, also refer to the extensions
|
||||
available. If using layers or other extensions, also refer to the extensions
|
||||
page for additional keycodes.
|
||||
```python
|
||||
from kb import KMKKeyboard
|
||||
|
@ -41,7 +41,7 @@ class MyKeyboard(KMKKeyboard):
|
||||
|
||||
The `keypad.Keys` scanner treats individual GPIO pins as discrete keys. To use
|
||||
this scanner, provide a sequence of pins that describes the layout of your
|
||||
board then include it in the initialisation sequence of your keyboard class.
|
||||
board then include it in the initialization sequence of your keyboard class.
|
||||
|
||||
```python
|
||||
import board
|
||||
@ -105,7 +105,7 @@ class MyKeyboard(KMKKeyboard):
|
||||
### digitalio MatrixScanner
|
||||
|
||||
The digitalio Matrix can scan over, as the name implies, `digitalio.DigitalInOut`
|
||||
objects. That is especially usefull if a matrix is build with IO-expanders.
|
||||
objects. That is especially useful if a matrix is build with IO-expanders.
|
||||
|
||||
```python
|
||||
from kmk.scanners.digitalio import MatrixScanner
|
||||
|
@ -6,7 +6,7 @@ Notice that this Split module must be added after the ModTap module to the keybo
|
||||
|
||||
## Wired UART
|
||||
Wired connections can use UART over 1 or 2 wires. With 2 wires, you will be able
|
||||
to syncronize the halves allowing additional features in some extensions.
|
||||
to synchronize the halves allowing additional features in some extensions.
|
||||
```python
|
||||
from kb import data_pin
|
||||
:from kmk.modules.split import Split, SplitType
|
||||
|
@ -35,7 +35,7 @@ A0/PF7 | A3
|
||||
## So how do I use it?
|
||||
1. The pads for the Pro Micro footprint are circled on the underside of the board. Solder male headers into these pads on the underside of the board (the same side as the markings) so that the pins extend "downward" so that they can be plugged into the keyboard.
|
||||
|
||||
2. The remaining pads are for the Itsy Bitsy. Assuming height is a concern, rather than soldering male headers into the Itsy Bitsy and female headers into the adapter board, instead place the long side of male headers through the Itsy Bitsy pads from underneath the board so that they protrude through he pads on the top of the board and solder them in place. Make sure to keep the headers perpindicular to the surface of the board.
|
||||
2. The remaining pads are for the Itsy Bitsy. Assuming height is a concern, rather than soldering male headers into the Itsy Bitsy and female headers into the adapter board, instead place the long side of male headers through the Itsy Bitsy pads from underneath the board so that they protrude through he pads on the top of the board and solder them in place. Make sure to keep the headers perpendicular to the surface of the board.
|
||||
|
||||
3. Once soldered, place the Itsy Bitsy board over the headers that are now protruding upwards so that the headers go through the pads of the ItsyBitsy and solder in place.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user