sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

spelling/capitalization/usage on proper nouns

Browse Source 
correct usage sourced from:
  * websites of respective trademark holders
  * Wiktionary
  * Wikipedia
This commit is contained in:
Ryan Rotter 2022-04-24 14:33:35 -05:00 committed by xs5871
parent 09d0287800
commit 1985712637
20 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -37,7 +37,7 @@ channel below.
- [Chainable
keys](https://github.com/KMKfw/kmk_firmware/blob/master/docs/keys.md) such as
`KC.LWIN(KC.L)` to lock the screen on a Windows PC
- [Built-in unicode macros, including
- [Built-in Unicode macros, including
emojis](https://github.com/KMKfw/kmk_firmware/blob/master/docs/sequences.md)
- [RGB underglow](https://github.com/KMKfw/kmk_firmware/blob/master/docs/rgb.md)
and [LED

4
boards/kyria/README.md
View File

@ -10,9 +10,9 @@ Keyboard works with controllers having Pro Micro layout. Existing configurations
| PCB version | Board | Config file |
|:-----------:|----------------------------------------------------------------------|---------------------------|
| 1.* | [Sparkfun Pro Micro RP2040](https://www.sparkfun.com/products/18288) | kyria_v1_rp2040 |
| 1.* | [SparkFun Pro Micro RP2040](https://www.sparkfun.com/products/18288) | kyria_v1_rp2040 |
| 1.* | [Adafruit KB2040](https://www.adafruit.com/product/5302) | kyria_v1_kb2040 |
| 2.* | [Sparkfun Pro Micro RP2040](https://www.sparkfun.com/products/18288) | _waiting for pinout docs_ |
| 2.* | [SparkFun Pro Micro RP2040](https://www.sparkfun.com/products/18288) | _waiting for pinout docs_ |
| 2.* | [Adafruit KB2040](https://www.adafruit.com/product/5302) | _waiting for pinout docs_ |
## Compatibility issues

6
docs/Officially_Supported_Microcontrollers.md
View File

@ -1,5 +1,5 @@
# Officially supported microcontrollers
While most Circuitpython devices are great for hand wired keyboards, most
While most CircuitPython devices are great for hand wired keyboards, most
keyboards are designed to accept a Pro Micro. The boards listed below either
are, or can be adapted to that pinout to use common keyboards already on the market.
@ -7,7 +7,7 @@ are, or can be adapted to that pinout to use common keyboards already on the mar
Features include
- Pro Micro pinout
- Both USB HID and Bluetooth support
- Can do bluetooth split keyboards with no wires at all
- Can do Bluetooth split keyboards with no wires at all
- Has battery support including charging
Downsides
@ -43,7 +43,7 @@ Downsides
Common Retailers
[Adafruit](https://www.adafruit.com/pico?src=raspberrypi)
[Sparkfun](https://www.sparkfun.com/products/17829?src=raspberrypi)
[SparkFun](https://www.sparkfun.com/products/17829?src=raspberrypi)
## Adafruit ItsyBitsy nRF52840 Express
Features include

6
docs/ble_hid.md
View File

@ -1,12 +1,12 @@
# BLE HID
Bluetooth connections help clean up the wire mess!
## Circuitpython
If not running KMKpython, this does require the adafruit_ble library from Adafruit.
## CircuitPython
If not running KMKPython, this does require the adafruit_ble library from Adafruit.
This can be downloaded
[here](https://github.com/adafruit/Adafruit_CircuitPython_BLE/tree/master/adafruit_ble).
It is part of the [Adafruit CircuitPython Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle).
Simply put this in the "root" of your circuitpython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device.
Simply put this in the "root" of your CircuitPython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device.
## Enabling BLE

4
docs/boot.md
View File

@ -4,7 +4,7 @@ There is a more detailed explanation in the [circuit python docs](https://docs.c
however there are some common use cases for your keyboard listed here.
## Hiding device storage
You can hide your device from showing up as a usb storage by default (this can be overridden
You can hide your device from showing up as a USB storage by default (this can be overridden
at startup if desired, per the example code further down this page).
```python
@ -28,7 +28,7 @@ usb_cdc.disable()
```
## Example code
Below is a fully working example, which disables usb storage, cdc and enables BIOS mode.
Below is a fully working example, which disables USB storage, CDC and enables BIOS mode.
```python
import supervisor

4
docs/cg_swap.md
View File

@ -1,5 +1,5 @@
# Ctrl Gui Swap
This module allows to swap Ctrl with Gui and vice versa. This will reset on restart to the default implementation
# Ctrl GUI Swap
This module allows to swap Ctrl with GUI and vice versa. This will reset on restart to the default implementation
## Enabling the module
```python

2
docs/contributing.md
View File

@ -25,7 +25,7 @@ to Black formatting as documented in `pyproject.toml`)
### Tests
Unit tests within the `tests` folder mock various CicuitPython modules to allow
Unit tests within the `tests` folder mock various CircuitPython modules to allow
them to be executed in a desktop development environment.
Execute tests using the command `python -m unittest`.

2
docs/easypoint.md
View File

@ -1,4 +1,4 @@
# AS5013 (aka. 'EasyPoint')
# AS5013 (aka 'EasyPoint')
Module handles the AM5013 Two-dimensional magnetic position sensor with digital coordinates output

2
docs/flashing.md
View File

@ -2,7 +2,7 @@
In general, we recommend using the instructions in `README.md`, however, mostly
as a development artifact, another method of flashing KMK exists (tested and
supported only on Linux, though it should also work on MacOS, the BSDs, and
supported only on Linux, though it should also work on macOS, the BSDs, and
other Unix-likes. It may also work on Cygwin and the Windows Subsystem for
Linux).

2
docs/keycodes.md
View File

@ -201,7 +201,7 @@
|`KC.BKDL` |Backspace when tapped, Delete when pressed with GUI |
|`KC.UC_MODE_NOOP` |Sets UnicodeMode to NOOP |
|`KC.UC_MODE_LINUX` |Sets UnicodeMode to Linux |
|`KC.UC_MODE_MACOS` |Sets UnicodeMode to MocOS |
|`KC.UC_MODE_MACOS` |Sets UnicodeMode to macOS |
|`KC.UC_MODE_WINC` |Sets UnicodeMode to WinCompose |
|`KC.MACRO_SLEEP_MS(ms)`|Sleeps in a macro. Check MACROS for more information. |

12
docs/kmkpython_vs_circuitpython.md
View File

@ -2,25 +2,25 @@
## Firmware of choice
### KMKPython
KMKPython is a fork of Circuitpython, but with libraries for most extensions
KMKPython is a fork of CircuitPython, but with libraries for most extensions
built in. This saves you from having to get them all and keep them updated
yourself. There may be other features added in the future that are exclusive to
KMKPython. For the nice!nano, this is highly recommended, and used in place of
Circuitpython.
CircuitPython.
Notable differences include
- Built in libraries for bluetooth, RGB, and more
- Built in libraries for Bluetooth, RGB, and more
- Saves space as builds are optimized for keyboards
- Microcontrollers like the nice!nano will be able to access all features out of
the box.
### Circuitpython
Circuitpython can be installed by following this guide using the guide
### CircuitPython
CircuitPython can be installed by following this guide using the guide
[here](https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython).
It's recommended to run the latest stable version that is at least 5.0 or higher.
Beta versions may work, but expect limited support.
#### Notable differences include
- Supports more devices
- Less built in libraries. If using RGB, bluetooth, and more, you will have to
- Less built in libraries. If using RGB, Bluetooth, and more, you will have to
add these libraries yourself
- Some devices such as the nice!nano don't have much free space, so not all
features can be installed at the same time

2
docs/modules.md
View File

@ -29,4 +29,4 @@ These modules are for specific hardware and may require additional libraries to
- [ADNS9800](adns9800.md): Controlling ADNS9800 optical sensor.
- [Encoder](encoder.md): Handling rotary encoders.
- [Pimoroni trackball](pimoroni_trackball.md): Handling a small I2C trackball made by Pimoroni.
- [AS5013 aka. easypoint](easypoint.md): Handling a small I2C magnetic position sensor made by AMS.
- [AS5013 aka EasyPoint](easypoint.md): Handling a small I2C magnetic position sensor made by AMS.

2
docs/power.md
View File

@ -1,5 +1,5 @@
# Power(save)
This module allows you to save power and is targeted to bluetooth/battery
This module allows you to save power and is targeted to Bluetooth/battery
based keyboards.
## Keycodes

2
docs/ptBR/Officially_Supported_Microcontrollers.md
View File

@ -45,7 +45,7 @@ Desvantagens:
Varejistas comuns:
- [Adafruit](https://www.adafruit.com/pico?src=raspberrypi)
- [Sparkfun](https://www.sparkfun.com/products/17829?src=raspberrypi)
- [SparkFun](https://www.sparkfun.com/products/17829?src=raspberrypi)
## Adafruit ItsyBitsy nRF52840 Express

18
docs/rgb.md
View File

@ -1,12 +1,12 @@
# RGB/Underglow/Neopixel
# RGB/Underglow/NeoPixel
Want your keyboard to shine? Add some lights!
## Circuitpython
If not running KMKpython, this does require the neopixel library from Adafruit.
## CircuitPython
If not running KMKPython, this does require the NeoPixel library from Adafruit.
This can be downloaded
[here](https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/6e35cd2b40575a20e2904b096508325cef4a71d3/neopixel.py).
It is part of the [Adafruit CircuitPython Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle).
Simply put this in the "root" of your circuitpython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device.
Simply put this in the "root" of your CircuitPython device. If unsure, it's the folder with main.py in it, and should be the first folder you see when you open the device.
Currently we support the following addressable LEDs:
@ -48,7 +48,7 @@ keyboard.extensions.append(rgb_ext)
|`KC.RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation |
|`KC.RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation |
|`KC.RGB_MODE_BREATHE_RAINBOW`|`RGB_M_BR` |Breathing rainbow animation |
|`KC.RGB_MODE_KNIGHT` |`RGB_M_K` |Knightrider animation |
|`KC.RGB_MODE_KNIGHT` |`RGB_M_K` |Knight Rider animation |
|`KC.RGB_MODE_SWIRL` |`RGB_M_S` |Swirl animation |
## Configuration
@ -133,14 +133,14 @@ add a 3 wires. The power wire will run on 3.3v or 5v (depending on the LED),
ground, and data pins will need added to an unused pin on your microcontroller
unless your keyboard has specific solder points for them. With those 3 wires
connected, set the `pixel_pin` as described above, and you are ready to use your
RGB LED's/Neopixels.
RGB LED's/NeoPixel.
## Troubleshooting
### Incorrect colors
If your colors are incorrect, check the pixel order of your specific LED's. Here are some common ones.
* WS2811, WS2812, WS2812B, WS2812C are all GRB (1, 0, 2)
* SK6812, SK6812MINI, SK6805 are all GRB (1, 0, 2)
* Neopixels will vary depending on which one you buy. It will be listed on the product page.
* NeoPixels will vary depending on which one you buy. It will be listed on the product page.
### Lights don't turn on
@ -152,10 +152,10 @@ installed LED's in total.
## Alternate LED chipsets
Not all RGB LEDs are compatible with Neopixels. To support these, the RGB
Not all RGB LEDs are compatible with NeoPixels. To support these, the RGB
extension accepts an instance of a `Pixelbuf`-compatible object as an optional
parameter. If supplied, `pixel_pin` is ignored and the supplied Pixelbuf is
used instead of creating a Neopixel object.
used instead of creating a NeoPixel object.
The RGB extension will figure out LED count from the pixelbuffer length if not
passed explicitly.

6
docs/sequences.md
View File

@ -1,7 +1,7 @@
# Sequences
Sequences are used for sending multiple keystrokes in a single action, and can
be used for things like unicode characters (even emojis! 🇨🇦), lorei epsum
be used for things like Unicode characters (even emojis! 🇨🇦), _Lorem ipsum_
generators, triggering side effects (think lighting, speakers,
microcontroller-optimized cryptocurrency miners, whatever). If you are still
unsure of what this is, most other vendors call these "Macros", but can do much
@ -76,7 +76,7 @@ On Windows, [WinCompose](https://github.com/samhocevar/wincompose) is required.
### Unicode Examples
To send a simple unicode symbol
To send a simple Unicode symbol
```python
from kmk.handlers.sequences import unicode_string_sequence
@ -104,7 +104,7 @@ keymap = [...emoticons.BEER, emoticons.HAND_WAVE...]
> `kmk.types.AttrDict`, which you can think of as a read-only view over a
> dictionary adding attribute-based (dot-notation) access.
Finally, if you need to send arbitrary unicode codepoints in raw form, that's
Finally, if you need to send arbitrary Unicode codepoints in raw form, that's
supported too, through `unicode_codepoint_sequence`.
```python

6
docs/split_keyboards.md
View File

@ -1,6 +1,6 @@
# Split Keyboards
Split keyboards are mostly the same as unsplit. Wired UART is fully supported,
and testing of bluetooth splits, though we don't currently offer support for this.
and testing of Bluetooth splits, though we don't currently offer support for this.
Notice that this Split module must be added after the ModTap module to the keyboard.modules.
@ -47,7 +47,7 @@ split = Split(
```
### EE HANDS
If you want to plug USB in on either side, or are using bluetooth, this is for
If you want to plug USB in on either side, or are using Bluetooth, this is for
you.
Rename your CIRCUITPY drive to something different. The left side must
@ -57,7 +57,7 @@ longer than 11 characters. Instructions on how to do that are
[here](https://learn.adafruit.com/welcome-to-circuitpython/the-circuitpy-drive).
For example on NYQUISTL for left and NYQUISTR for the right.
For wired connections you don't need to pass anything. For bluetooth, remove the `split_side` like this
For wired connections you don't need to pass anything. For Bluetooth, remove the `split_side` like this
```python
# Wired
split = Split()

2
hardware/README-ptBR.md
View File

@ -4,7 +4,7 @@
Esta placa adapta a pinagem de uma [Adafruit Itsy Bitsy M4
Express](https://www.adafruit.com/product/3800) compatível com o CircuitPython
para aquela da [Sparkfun Pro Micro](https://www.sparkfun.com/products/12640) a
para aquela da [SparkFun Pro Micro](https://www.sparkfun.com/products/12640) a
fim de permitir que a Itsy Bitsy seja usável com os diversos teclados que
suportam a planta do Pro Micro.

2
hardware/README.md
View File

@ -2,7 +2,7 @@
## ItsyBitsy to Pro Micro pinout adapter
This board adapts the pinout of a Circuit Python compatible [Adafruit Itsy Bitsy M4 Express](https://www.adafruit.com/product/3800) to that of the [Sparkfun Pro Micro](https://www.sparkfun.com/products/12640) to allow the Itsy Bitsy to be used with the many keyboards that support the footprint of the Pro Micro.
This board adapts the pinout of a Circuit Python compatible [Adafruit ItsyBitsy M4 Express](https://www.adafruit.com/product/3800) to that of the [SparkFun Pro Micro](https://www.sparkfun.com/products/12640) to allow the ItsyBitsy to be used with the many keyboards that support the footprint of the Pro Micro.
## Pin mapping
Pro Micro Pin | ItsyBitsy Pin